Get account verification report

get/accountVerification/reports/{code}

API Version

Get the account verification report using a unique code from a successful open banking connection. This report provides identity verification and bank account details.

Endpoint destination URL

Path Parameters

Required

Optional

The unique code you receive after a successful open banking flow that is included as a query parameter in the redirectUrl callback.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
accountsarray[object]
A list of bank accounts with their respective information.
accountIdstring
The unique identifier for the bank account.
accountNamestring
The name of the bank account. This name is assigned by the banking institution, and it describes the type of bank account.
accountNumberstring
The account number of the bank account.
accountTypestring
The type of the bank account. Possible values are CURRENT, SAVINGS, BUSINESS, CREDIT_CARD, LOAN, UNKNOWN.
bankNamestring
The name of the banking institution where the bank account is held.
currencystring
The currency of the funds in the bank account.
identifiersobject
Contains various codes and details used to uniquely identify the bank account across different regions.
achobject
Identifiers relevant for Automated Clearing House (ACH) payments, primarily used in the United States.
accountLastDigitsstring
The last digits of the account number. If the accountNumber is tokenized, this field contains the last digits of the non-tokenized account number. This helps users verify the account without seeing the full number.
accountNumberstring
The account number of the bank account.
isTokenizedboolean
Indicates whether the account number is tokenized. A tokenized account number is a unique ID generated by a bank to protect the user's actual account number.
routingNumberstring
The routing number, without separators or whitespace.
bacsobject
Identifiers relevant for Bankers' Automated Clearing Services (BACS) payments, primarily used in the United Kingdom.
accountNumberstring
The account number of the bank account.
sortCodestring
A number that identifies the specific bank and branch where a UK bank account is held.
bsbobject
Identifiers relevant for Australian banking, specifically for BSB (Bank-State-Branch) numbers.
accountNumberstring
The account number of the bank account.
bsbCodestring
The BSB (Bank-State-Branch) code.
eftobject
Identifiers relevant for Electronic Funds Transfer (EFT) payments, commonly used in Canada.
accountNumberstring
The account number of the bank account.
branchstring
Identifies the specific branch where the account is held within the Canadian banking system.
institutionstring
The financial institution that identifies the bank in Canada.
ibanobject
The international bank account number as defined in the ISO-13616 standard.
bbanstring
The Basic Bank Account Number (BBAN) component of the IBAN.
bicstring
BIC of a bank account.
ibanstring
The international bank account number as defined in the ISO-13616 standard. This is the national identifier for the bank account, following the country-specific format, and is part of the full IBAN.
rixobject
Identifiers relevant for the Rix (Russian Interbank eXchange) system, used for interbank payments within Russia.
accountNumberstring
The account number of the bank account.
clearingNumberstring
The 4- to 5-digit clearing number, without separators or whitespace.
partiesarray[object]
Contains details of all parties associated with the report.
identityobject
Contains the identity details of the party.
fullLegalNamestring
The complete legal name of the individual or entity.
namestring
A commonly used or human-readable name for the individual or entity.
rolestring
Specifies a role or capacity of the party in relation to the bank account.
countrystring
The location where the third-party individual's bank account is registered.
idstring
The unique identifier for the specific report.
400 - Bad Request
The request is malformed or is not in the expected format.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized
The API credential used in the request is invalid or does not have the right permissions.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
404 - Not Found
The entity was not found.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
429 - Too Many Requests
Request rate limit exceeded.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Service Error
An unrecoverable error occurred while trying to perform the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get account verification report

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

404 - Not Found

422 - Unprocessable Entity

429 - Too Many Requests

500 - Internal Service Error