Verify an external account
Checks account details before you add the external account, and returns the holder's name when the bank can look it up. Send account_number with institution_id. Only that pair reaches the bank.
verified: true with verification_source: local means only the format was checked. Trust the name only when verification_source is provider. An IBAN, phone or CLABE alone is checked locally. This route needs no Idempotency-Key.
Request Body
The only identifier that the bank looks up
The bank to ask. Without it the lookup is not scoped to a bank.
Checked with mod 97 only
Accepted, but not verified
Accepted, but not verified
Request Examples
{
"account_number": "0123456789",
"institution_id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f"
}
Responses
| Status | Description |
|---|---|
200 |
The result. verified is false when a local check failed. |
400 |
No identifier, or an invalid institution ID |
200 response
In upper case. Only when the bank confirmed the account.
True when the bank masked the name
Why verified is false
For reference only, in major units
For reference only, in major units
provider when a bank confirmed it, local for format checks only
Possible values: provider, local
{
"data": {
"verified": true,
"account_holder_name": "ADA OKAFOR",
"verification_source": "provider"
},
"error": null
}
400 response
Null, except for a duplicate, which returns the existing payee_id
What went wrong
Error code such as ERROR_CODE_DUPLICATE_PAYEE, when one is sent
{
"data": null,
"error": "at least one account identifier required: account_number, iban, phone, or clabe"
}
Authorization
- ApiKeyAuth