Get full customer (ToraWallet)

GET 
/CustomerTorra/:customerCode/FullWithExtraProperties

Get full customer (ToraWallet)

Request

Path Parameters

customerCode stringrequired

The unique identifier of the customer.

Responses

200

Returns the customer with all properties including extra properties.

application/json

Schema

Schema

customerCode stringnullablerequired

The unique code identifying the customer.

customerTypeCode stringnullablerequired

The code identifying the customer's type classification.

customerLegalTypeCode stringnullablerequired

The code identifying the customer's legal entity type.

lastname stringnullablerequired

The customer's primary last name.

lastname2 stringnullablerequired

The customer's secondary or maiden last name.

middleName stringnullablerequired

The customer's middle name.

firstname stringnullablerequired

The customer's first name.

fatherName stringnullablerequired

The customer's father's name.

motherName stringnullablerequired

The customer's mother's name.

birthDate date-timenullablerequired

The customer's date of birth.

gender int32nullablerequired

The customer's gender (numeric code).

mobilePhone1 stringnullablerequired

The customer's primary mobile phone number.

mobilePhone2 stringnullablerequired

The customer's secondary mobile phone number.

emailAddress1 stringnullablerequired

The customer's primary email address.

emailAddress2 stringnullablerequired

The customer's secondary email address.

taxCode stringnullablerequired

The customer's tax identification number.

taxOfficeCode stringnullablerequired

The code of the tax office where the customer is registered.

dependentMembers int32nullablerequired

The number of dependent family members.

educationLevelCode stringnullablerequired

The code identifying the education level.

originCityName stringnullablerequired

The name of the customer's city of origin.

originCountryCode stringnullablerequired

The ISO country code of the origin country.

nationalityCountryCode stringnullablerequired

The ISO country code of the customer's nationality.

teiresiasType stringnullablerequired

The Tiresias (credit bureau) classification type for the customer.

activeDate date-timenullablerequired

The date when the customer record was activated.

deactivationDate date-timenullablerequired

The date when the customer record was deactivated.

customerBranchCode stringnullablerequired

The code of the branch that owns this customer record.

customerWatchingBranchCode stringnullablerequired

The code of the branch responsible for monitoring this customer.

customerStatusCode stringnullablerequired

The code representing the customer's current status.

customerKycDate date-timenullablerequired

The date of the customer's most recent Know Your Customer (KYC) review.

customerRegistrationNumber stringnullablerequired

The customer's official registration number.

customerDisabilities stringnullablerequired

Information about any disabilities recorded for the customer.

customerTaxResidentPlace int32nullablerequired

The numeric identifier of the customer's tax residence location.

onBoardingStatusCode stringnullablerequired

The code representing the customer's onboarding status.

onBoardingStatusTitle stringnullablerequired

The display title of the customer's onboarding status.

bussinessTypeTitle stringnullablerequired

The display title of the customer's business type.

bussinessTypeCode stringnullablerequired

The code identifying the customer's business type.

customerBussinessTypeCode stringnullablerequired

The code identifying the customer's business type.

customerBussinessTypeTitle stringnullablerequired

The display title of the customer's business type.

birthPlaceCityCode stringnullablerequired

The code of the city where the customer was born.

birthPlaceCityName stringnullablerequired

The name of the city where the customer was born.

custCodeOriginal stringnullablerequired

The customer's original code before any code migration or update.

taxResidenceResponse object

The customer's tax residence details.

recidenceTitle stringnullablerequired

The display title of the tax residence.

createdBy stringnullablerequired

The username or identifier of the user who created this record.

createdAt date-timenullablerequired

The date and time when this record was created.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

updatedAt date-timenullablerequired

The date and time when this record was last updated.

customerRelations object[]nullable
The list of relationships associated with this customer.
Array [
relationID int32required
The numeric identifier of the customer relationship.
relationDescription stringnullablerequired
A textual description of the relationship type.
]
customerYearIncomes object[]nullable
The list of yearly income records for this customer.
Array [
fiscalYear int32nullablerequired
The fiscal year for which the income is reported.
yearIncome doublenullablerequired
The total annual income amount.
incomeTypeCode stringnullablerequired
The code identifying the type of income.
incomeTypeTitle stringnullablerequired
The display title of the income type.
createInfo object
Audit metadata capturing who created this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
]
customerAmlCode stringnullablerequired

The AML-specific code assigned to the customer.

customerTypeTitle stringnullablerequired

The display title of the customer type.

customerLegalTypeTitle stringnullablerequired

The display title of the customer's legal entity type.

taxOfficeTitle stringnullablerequired

The display title of the tax office.

educationLevelTitle stringnullablerequired

The display title of the education level.

originCountryName stringnullablerequired

The display name of the customer's country of origin.

nationalityCountryName stringnullablerequired

The display name of the customer's nationality country.

customerBranchTitle stringnullablerequired

The display title of the branch that owns this customer record.

customerWatchingBranchTitle stringnullablerequired

The display title of the branch responsible for monitoring this customer.

customerStatusTitle stringnullablerequired

The display title of the customer status.

custRiskLevelCode int32required

The risk level code assigned to the customer.

riskLevelCodeComputeMode booleanrequired

The computation mode used for the risk level code.

amlFlag booleanrequired

The AML flag status of the customer.

reportToAuthorities booleanrequired

Indicates whether this customer should be reported to regulatory authorities.

reportToAuthoritiesDate date-timenullablerequired

The date when the customer was reported to authorities.

amlCustDateUpdated date-timerequired

The date when the customer's AML record was last updated.

foundInSanctionLists string[]nullablerequired

Indicates whether the customer was found in any sanction list.

foundInPepLists string[]nullablerequired

Indicates whether the customer was found in any PEP list.

customerAddresses object[]nullable
The list of addresses associated with this customer.
Array [
id int32required
The unique identifier of this record.
correlationKey stringnullablerequired
A unique key used to correlate related records across operations.
addressTypeCode stringnullablerequired
The code identifying the type of address (e.g., home, work).
line1 stringnullablerequired
The first line of the address.
line2 stringnullablerequired
The second line of the address.
line3 stringnullablerequired
The third line of the address.
postCode stringnullablerequired
The postal or ZIP code.
cityName stringnullablerequired
The name of the city.
provinceName stringnullablerequired
The name of the province or region.
countryCode stringnullablerequired
The unique country code.
telephone stringnullablerequired
The telephone number associated with this address.
activeFrom date-timenullablerequired
The date from which this record is active.
activeTo date-timenullablerequired
The date until which this record is active.
isMain booleannullablerequired
Indicates whether this is the primary or main record.
addressTypeTitle stringnullablerequired
The display title of the address type.
countryName stringnullablerequired
The display name of the country.
createInfo object
Audit metadata capturing who created this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
]
customerIdentities object[]nullable
The list of identity documents associated with this customer.
Array [
id int32required
The unique identifier of this record.
correlationKey stringnullablerequired
A unique key used to correlate related records across operations.
identityTypeCode stringnullablerequired
The code identifying the type of identity document.
identityNumber stringnullablerequired
The identity document number.
issueCountryCode stringnullablerequired
The ISO country code of the country that issued the identity document.
issueCityName stringnullablerequired
The name of the city where the identity document was issued.
issueProvinceName stringnullablerequired
The name of the province where the identity document was issued.
issueDate date-timenullablerequired
The date when the identity document was issued.
expirationDate date-timenullablerequired
The expiration date of the identity document.
identityTypeTitle stringnullablerequired
The display title of the identity document type.
issueCountryName stringnullablerequired
The name of the country that issued the identity document.
isExpired booleannullablerequired
Indicates whether the identity document has expired.
createInfo object
Audit metadata capturing who created this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
]
customerProfessions object[]nullable
The list of professions associated with this customer.
Array [
id int32required
The unique identifier of this record.
professionCode stringnullablerequired
The code identifying the profession.
activeFrom date-timenullablerequired
The date from which this record is active.
activeTo date-timenullablerequired
The date until which this record is active.
professionTitle stringnullablerequired
The display title of the profession.
createInfo object
Audit metadata capturing who created this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
]
id int32required

The unique identifier of this record.

customerId int32required

The internal numeric identifier of the customer.

canClientBeModified booleanrequired

Indicates whether the customer record can be modified.

custMobilePhone1Emergency booleannullablerequired

Indicates whether the primary mobile phone is an emergency contact.

custMobilePhone1ContactHours stringnullablerequired

The preferred contact hours for the primary mobile phone.

custMobilePhone2Emergency booleannullablerequired

Indicates whether the secondary mobile phone is an emergency contact.

custMobilePhone2ContactHours stringnullablerequired

The preferred contact hours for the secondary mobile phone.

custChronocashCode stringnullablerequired

The customer's Chronocash system code.

custLanguageCode stringnullablerequired

The preferred language code of the customer.

custPreferableContactMediumCode stringnullablerequired

The customer's preferred contact medium code.

reviewCustomer booleanrequired

Indicates whether this customer is flagged for review.

addresses object[]nullable
The list of customer addresses.
Array [
correlationKey stringnullablerequired
A unique key used to correlate related records across operations.
addressTypeCode stringnullablerequired
The code identifying the type of address (e.g., home, work).
line1 stringnullablerequired
The first line of the address.
line2 stringnullablerequired
The second line of the address.
line3 stringnullablerequired
The third line of the address.
postCode stringnullablerequired
The postal or ZIP code.
cityName stringnullablerequired
The name of the city.
provinceName stringnullablerequired
The name of the province or region.
countryCode stringnullablerequired
The unique country code.
telephone stringnullablerequired
The telephone number associated with this address.
activeFrom date-timenullablerequired
The date from which this record is active.
activeTo date-timenullablerequired
The date until which this record is active.
isMain booleannullablerequired
Indicates whether this is the primary or main record.
addressTypeTitle stringnullablerequired
The display title of the address type.
countryName stringnullablerequired
The display name of the country.
createInfo object
Audit metadata capturing who created this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
id int32required
The unique identifier of this record.
customerId int32required
The internal numeric identifier of the customer.
customerAddressesId int32required
The internal identifier of the customer address record.
telephoneTypeCode stringnullablerequired
The code identifying the type of telephone (e.g., mobile, landline).
telephoneContactHours stringnullablerequired
The preferred contact hours for this telephone number.
telephoneEmergency booleannullablerequired
Indicates whether this telephone number is an emergency contact.
]
identities object[]nullable
The list of customer identity documents.
Array [
correlationKey stringnullablerequired
A unique key used to correlate related records across operations.
identityTypeCode stringnullablerequired
The code identifying the type of identity document.
identityNumber stringnullablerequired
The identity document number.
issueCountryCode stringnullablerequired
The ISO country code of the country that issued the identity document.
issueCityName stringnullablerequired
The name of the city where the identity document was issued.
issueProvinceName stringnullablerequired
The name of the province where the identity document was issued.
issueDate date-timenullablerequired
The date when the identity document was issued.
expirationDate date-timenullablerequired
The expiration date of the identity document.
identityTypeTitle stringnullablerequired
The display title of the identity document type.
issueCountryName stringnullablerequired
The name of the country that issued the identity document.
isExpired booleannullablerequired
Indicates whether the identity document has expired.
createInfo object
Audit metadata capturing who created this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
actionBy stringnullablerequired
The username or identifier of the user who performed the action.
actionAt date-timerequired
The date and time when the action was performed.
id int32required
The unique identifier of this record.
identityImage1 stringnullablerequired
The first identity document image (Base64-encoded or reference).
identityImage2 stringnullablerequired
The second identity document image (Base64-encoded or reference).
customerIdentityId int32required
The internal identifier of the customer identity record.
customerId int32required
The internal numeric identifier of the customer.
activeFrom date-timerequired
The date from which this record is active.
activeTo date-timerequired
The date until which this record is active.
identityNumberInLatin stringnullablerequired
The identity number transliterated to Latin characters.
rsphotosId int32nullablerequired
The identifier of the associated photos record in the RS system.
]
transactionInfo object

The customer's transaction information and estimates.

id int32required

The unique identifier of this record.

customerId int32required

The internal numeric identifier of the customer.

estimatedTransactionCount doublerequired

The estimated number of transactions expected per period.

estimatedTransactionValue doublerequired

The estimated total value of transactions expected per period.

averageTransactionValue doublerequired

The average value per transaction.

createdAt date-timerequired

The date and time when this record was created.

createdBy stringnullablerequired

The username or identifier of the user who created this record.

updatedAt date-timerequired

The date and time when this record was last updated.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

transactionalProfiles object[]nullable
The customer's transactional profile data.
Array [
id int32required
The unique identifier of this record.
customerId int32required
The internal numeric identifier of the customer.
completedTransactionCount doublerequired
The number of completed transactions.
totalTransactionValue doublerequired
The total value of all completed transactions.
averageTransactionValue doublerequired
The average value per transaction.
transactionCountCard doublerequired
The number of transactions made via card.
totalTransactionValueCard doublerequired
The total value of card transactions.
transactionCountCashOnDelivery doublerequired
The number of cash-on-delivery transactions.
totalTransactionValueCashOnDelivery doublerequired
The total value of cash-on-delivery transactions.
cancelledTransactionsCount doublerequired
The number of cancelled transactions.
complaintsCount int32required
The number of complaints filed by or against the customer.
createdAt date-timerequired
The date and time when this record was created.
createdBy stringnullablerequired
The username or identifier of the user who created this record.
updatedAt date-timerequired
The date and time when this record was last updated.
updatedBy stringnullablerequired
The username or identifier of the user who last updated this record.
]

Example (from schema)

{
  "customerCode": "string",
  "customerTypeCode": "string",
  "customerLegalTypeCode": "string",
  "lastname": "string",
  "lastname2": "string",
  "middleName": "string",
  "firstname": "string",
  "fatherName": "string",
  "motherName": "string",
  "birthDate": "2024-07-29T15:51:28.071Z",
  "gender": 0,
  "mobilePhone1": "string",
  "mobilePhone2": "string",
  "emailAddress1": "string",
  "emailAddress2": "string",
  "taxCode": "string",
  "taxOfficeCode": "string",
  "dependentMembers": 0,
  "educationLevelCode": "string",
  "originCityName": "string",
  "originCountryCode": "string",
  "nationalityCountryCode": "string",
  "teiresiasType": "string",
  "activeDate": "2024-07-29T15:51:28.071Z",
  "deactivationDate": "2024-07-29T15:51:28.071Z",
  "customerBranchCode": "string",
  "customerWatchingBranchCode": "string",
  "customerStatusCode": "string",
  "customerKycDate": "2024-07-29T15:51:28.071Z",
  "customerRegistrationNumber": "string",
  "customerDisabilities": "string",
  "customerTaxResidentPlace": 0,
  "onBoardingStatusCode": "string",
  "onBoardingStatusTitle": "string",
  "bussinessTypeTitle": "string",
  "bussinessTypeCode": "string",
  "customerBussinessTypeCode": "string",
  "customerBussinessTypeTitle": "string",
  "birthPlaceCityCode": "string",
  "birthPlaceCityName": "string",
  "custCodeOriginal": "string",
  "taxResidenceResponse": {
    "recidenceTitle": "string",
    "createdBy": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z"
  },
  "customerRelations": [
    {
      "relationID": 0,
      "relationDescription": "string"
    }
  ],
  "customerYearIncomes": [
    {
      "fiscalYear": 0,
      "yearIncome": 0,
      "incomeTypeCode": "string",
      "incomeTypeTitle": "string",
      "createInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "updateInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      }
    }
  ],
  "customerAmlCode": "string",
  "customerTypeTitle": "string",
  "customerLegalTypeTitle": "string",
  "taxOfficeTitle": "string",
  "educationLevelTitle": "string",
  "originCountryName": "string",
  "nationalityCountryName": "string",
  "customerBranchTitle": "string",
  "customerWatchingBranchTitle": "string",
  "customerStatusTitle": "string",
  "custRiskLevelCode": 0,
  "riskLevelCodeComputeMode": true,
  "amlFlag": true,
  "reportToAuthorities": true,
  "reportToAuthoritiesDate": "2024-07-29T15:51:28.071Z",
  "amlCustDateUpdated": "2024-07-29T15:51:28.071Z",
  "foundInSanctionLists": [
    "string"
  ],
  "foundInPepLists": [
    "string"
  ],
  "customerAddresses": [
    {
      "id": 0,
      "correlationKey": "string",
      "addressTypeCode": "string",
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "postCode": "string",
      "cityName": "string",
      "provinceName": "string",
      "countryCode": "string",
      "telephone": "string",
      "activeFrom": "2024-07-29T15:51:28.071Z",
      "activeTo": "2024-07-29T15:51:28.071Z",
      "isMain": true,
      "addressTypeTitle": "string",
      "countryName": "string",
      "createInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "updateInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      }
    }
  ],
  "customerIdentities": [
    {
      "id": 0,
      "correlationKey": "string",
      "identityTypeCode": "string",
      "identityNumber": "string",
      "issueCountryCode": "string",
      "issueCityName": "string",
      "issueProvinceName": "string",
      "issueDate": "2024-07-29T15:51:28.071Z",
      "expirationDate": "2024-07-29T15:51:28.071Z",
      "identityTypeTitle": "string",
      "issueCountryName": "string",
      "isExpired": true,
      "createInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "updateInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      }
    }
  ],
  "customerProfessions": [
    {
      "id": 0,
      "professionCode": "string",
      "activeFrom": "2024-07-29T15:51:28.071Z",
      "activeTo": "2024-07-29T15:51:28.071Z",
      "professionTitle": "string",
      "createInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "updateInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      }
    }
  ],
  "id": 0,
  "customerId": 0,
  "canClientBeModified": true,
  "custMobilePhone1Emergency": true,
  "custMobilePhone1ContactHours": "string",
  "custMobilePhone2Emergency": true,
  "custMobilePhone2ContactHours": "string",
  "custChronocashCode": "string",
  "custLanguageCode": "string",
  "custPreferableContactMediumCode": "string",
  "reviewCustomer": true,
  "addresses": [
    {
      "correlationKey": "string",
      "addressTypeCode": "string",
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "postCode": "string",
      "cityName": "string",
      "provinceName": "string",
      "countryCode": "string",
      "telephone": "string",
      "activeFrom": "2024-07-29T15:51:28.071Z",
      "activeTo": "2024-07-29T15:51:28.071Z",
      "isMain": true,
      "addressTypeTitle": "string",
      "countryName": "string",
      "createInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "updateInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "id": 0,
      "customerId": 0,
      "customerAddressesId": 0,
      "telephoneTypeCode": "string",
      "telephoneContactHours": "string",
      "telephoneEmergency": true
    }
  ],
  "identities": [
    {
      "correlationKey": "string",
      "identityTypeCode": "string",
      "identityNumber": "string",
      "issueCountryCode": "string",
      "issueCityName": "string",
      "issueProvinceName": "string",
      "issueDate": "2024-07-29T15:51:28.071Z",
      "expirationDate": "2024-07-29T15:51:28.071Z",
      "identityTypeTitle": "string",
      "issueCountryName": "string",
      "isExpired": true,
      "createInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "updateInfo": {
        "actionBy": "string",
        "actionAt": "2024-07-29T15:51:28.071Z"
      },
      "id": 0,
      "identityImage1": "string",
      "identityImage2": "string",
      "customerIdentityId": 0,
      "customerId": 0,
      "activeFrom": "2024-07-29T15:51:28.071Z",
      "activeTo": "2024-07-29T15:51:28.071Z",
      "identityNumberInLatin": "string",
      "rsphotosId": 0
    }
  ],
  "transactionInfo": {
    "id": 0,
    "customerId": 0,
    "estimatedTransactionCount": 0,
    "estimatedTransactionValue": 0,
    "averageTransactionValue": 0,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "createdBy": "string",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string"
  },
  "transactionalProfiles": [
    {
      "id": 0,
      "customerId": 0,
      "completedTransactionCount": 0,
      "totalTransactionValue": 0,
      "averageTransactionValue": 0,
      "transactionCountCard": 0,
      "totalTransactionValueCard": 0,
      "transactionCountCashOnDelivery": 0,
      "totalTransactionValueCashOnDelivery": 0,
      "cancelledTransactionsCount": 0,
      "complaintsCount": 0,
      "createdAt": "2024-07-29T15:51:28.071Z",
      "createdBy": "string",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "updatedBy": "string"
    }
  ]
}

400

If the customerCode is invalid or missing.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

If no customer is found for the provided customerCode.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

500

If there is an internal server error while fetching the data.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...