Returns a result with an accompanying error code if validation is inconclusive.
Atto Developer Documentation (all)
Download OpenAPI description
Overview
URL
API Support
License
Languages
Servers
UK Environment (Production)
https://uk.api.atto.co/
US Environment (Production)
https://us.api.atto.co/
In response to your call, you will receive a JSON object containing the verification result and optionally a reason of a failed verification.
We currently support IBAN or a bank code as account identifiers. Given below is a list of supported bank codes for a country/region.
| Bank Code | Region |
|---|---|
| Routing Number | US, CA |
| Sort Code | UK |
| BIC | Global provided the bank is part of SWIFT. Please note not all banks will expose this even if they are part of the SWIFT network. |
Body
- application/json-patch+json
- application/json
- text/json
- application/*+json
Bank account details
Bank Identifier Code (BIC) is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned.
The national bank transit or transfer code used for identification of the bank assigned by a central bank in a country, eg: A Routing number(US/CA) or Sort code(UK)
- UK Environment (Production)
https://uk.api.atto.co/account-verification/v3/consents/{consentId}
- US Environment (Production)
https://us.api.atto.co/account-verification/v3/consents/{consentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://uk.api.atto.co/account-verification/v3/consents/{consentId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"accountHolderName": "string",
"identifier": {
"iban": "string",
"bic": "string",
"bankCode": "string",
"accountNumber": "string",
"countryCode": "string"
},
"ignoreMiddleNames": true
}'Account verification result. The result can be one of the following four statuses:
- Pass - Account identifiers were found and name(s) were matched.
- Fail - Account identifiers were found and name(s) were not matched.
- Partial - Account identifiers were not found and name(s) were matched.
- NA - Inconclusive result, please see the reason code for details.
Enum"Pass""Fail""NA""Partial"
Enum"AccountIdentifierNotFound""PartyNameNotFound""NameOnlyMatch"
Response
application/json
{ "result": "Pass", "reason": "AccountIdentifierNotFound", "matchedAccount": { "countryCode": "string", "accountNumber": "string", "bankCode": "string", "iban": "string", "bic": "string", "type": "Iban" }, "matchedAccountHolderName": "string" }