Retrieves information from the account given an accountId.
OAuth Grant type, Private JWT
Client ID header.
Device information permitted for the data query.
You can use this parameter to apply an experience base to optimize data collection.
Identifier of the account. The number format is defined in the "account_id_type" parameter.
Account id country
Account id type
Data structure showing accounts verifications.
{
"accountVerifications": {
"status": "Blocked-DR",
"baseCurrency": "GBP",
"accounting": {
"accountingId": "virtual_account",
"accountingName": "Virtual Account"
},
"virtualAccountStructureId": "2507b89c-b680-46df-9505-e0c6f78cf295",
"customer": {
"customerId": "PNXTGB2LXXXUK1234567891",
"segmentCode": "sme",
"customerName": "Customer Company Name",
"customerAddresses": [
{
"floor": "3",
"state": "Barcelona",
"country": "ES",
"postCodeIdentification": "28084"
}
]
},
"product": {
"permittedActivities": [
"first_party"
]
}
}
}Data structure showing all accounts verifications.
Verifications data of the account
Account status. The possible values are:
- Open = Account is open and movements are restricted only by the customers available balance and account contract attributes.
- Blocked by customer= The account is open but is blocked for credit, blocked for debit, or both, ONLY if this block was set by customer itself. In case it is blocked by other distinct to customer, the status will be Blocked.
- Blocked = Account has some restrictive block.
- Closed = Account is closed.
Currency code. The value is the alpha-3 format defined in ISO 4217 (https://www.iso.org/iso-4217-currency-codes.html).
UUID identification type
Data structure that represent an account type.
Accounting Identification of the customer account.
Accounting Name of the customer account.
Customer associated with an account.
Customer identifier of the customer whose accounts are to be included in the response. Applies only when Santander staff wants to access data on the customer's behalf.
Segment code (classification) in which the bank has categorized the customer. Possible values (sme, corp, mnc, bank, emi, api, regulated_corp, lc, fi, nbfi).
Customer Name associated with the account
List containing customer addresses
Data structure containing customer addresses
Product associated with an account.
Activities that the product can handle.
Activity that the customer must handle to apply for the product.
No content
Bad Request
{
"errors": [
{
"code": "INVALID_SCHEMA",
"message": "Invalid input.",
"level": "ERROR",
"description": "Error validating schema."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"message": "A token must be provided.",
"level": "ERROR",
"description": "There was an error during token verification in header [authorization]"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Forbidden
{
"errors": [
{
"code": "OPERATION_NOT_ALLOWED",
"message": "operation not allowed due to lack of permissions.",
"level": "ERROR",
"description": "Operation not allowed due to lack of permissions."
}
]
}{
"errors": [
{
"code": "INVALID_AUTH_TOKEN",
"message": "The token provided is invalid.",
"level": "ERROR",
"description": "Invalid auth token."
}
]
}{
"errors": [
{
"code": "FORBIDDEN",
"message": "A token must be provided.",
"level": "ERROR",
"description": "Operation not allowed due to lack of permissions."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
The account does not exist.
{
"errors": [
{
"code": "ACCOUNT_NOT_FOUND",
"level": "ERROR",
"message": "Account not found.",
"description": "The data related to the account with identifier \"a26c7fc3-3f9b-4045-a946-24e565bee1f9\" could not be found."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Method Not Allowed
{
"errors": [
{
"code": "METHOD_NOT_ALLOWED",
"level": "ERROR",
"message": "Method not allowed",
"description": "The request method is known by the server but is not supported by the target resource."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Not Acceptable
{
"errors": [
{
"code": "NOT_ACCEPTABLE",
"level": "ERROR",
"message": "Not Acceptable",
"description": "This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Conflict
{
"errors": [
{
"code": "CONFLICT",
"level": "ERROR",
"message": "Conflict",
"description": "This response is sent when a request conflicts with the current state of the server."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Payload too large
{
"errors": [
{
"code": "PAYLOAD_TOO_LARGE",
"level": "ERROR",
"message": "Payload too large",
"description": "Request entity is larger than limits defined by server. The server might close the connection or return an Retry-After header field."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Request URI Too Long
{
"errors": [
{
"code": "URI_TOO_LARGE",
"level": "ERROR",
"message": "URI too large",
"description": "The URI requested by the client is longer than the server is willing to interpret."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unsupported Media Type
{
"errors": [
{
"code": "UNSUPPORTED_MEDIA_TYPE",
"level": "ERROR",
"message": "Unsupported Media Type",
"description": "The media format of the requested data is not supported by the server, so the server is rejecting the request."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Unprocessable Entity
{
"errors": [
{
"code": "UNPROCESSABLE_ENTITY",
"level": "ERROR",
"message": "Unprocessable entity.",
"description": "The request was well-formed but was unable to be followed due to semantic errors."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Too Many Requests
{
"errors": [
{
"code": "TOO_MANY_REQUESTS",
"level": "ERROR",
"message": "Too many requests.",
"description": "The user has sent too many requests in a given amount of time"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error.",
"level": "ERROR",
"description": "INTERNAL_SERVER_ERROR"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Service Down Error
{
"errors": [
{
"code": "SERVICE_DOWN_ERROR",
"message": "Service down error.",
"level": "ERROR",
"description": "Service down error."
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Gateway Timeout Error
{
"errors": [
{
"code": "GATEWAY_TIMEOUT_ERROR",
"message": "Gateway timeout error.",
"level": "ERROR",
"description": "Gateway timeout error"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.
Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error.",
"level": "ERROR",
"description": "INTERNAL_SERVER_ERROR"
}
]
}Data structure containing the details for errors.
Array of errors.
Data structure containing error details.
Unique alphanumeric human readable error code.
Brief summary of the reported issue.
Level of the reported issue. The possible values are:
- ERROR
- FATAL
- INFO
- WARNING
Detailed description of the reported issue.