Verify an external account
Resolves and verifies a recipient's account with the destination institution before you add them as an external account. Use it to confirm the account holder's name and that the account is reachable, so you can show the resolved name and avoid failed transfers.
Pass at least one identifier: account_number, iban, phone, or
clabe. The service detects the account type, validates its format,
then resolves the name with the institution.
is_verified: true— the account resolved.account_nameholds the confirmed holder name.is_verified: false— the account could not be resolved. Any institutions that matched the identifier are returned ininstitutionsso the user can pick one and retry.
Verification is supported for bank accounts and mobile money today.
Other types (IBAN, SWIFT) return is_verified: false.
Request Body
Bank account number.
Institution UUID from GET /v1/external-accounts/institutions. Speeds up and disambiguates resolution.
Mobile money number in international format.
Mexican CLABE account number.
ISO 3166-1 alpha-2 country code.
Beneficiary owner type. Lets the institution pick the right flow for business versus individual recipients.
Possible values: individual, business
Request Examples
{
"account_number": "1776218486",
"institution_id": "c0cb83fa-8116-4744-8bc8-0c1cba405400",
"country_code": "NG"
}
{
"phone": "+233241234567",
"institution_id": "5c8d94fb-a927-5fed-b19d-1454c8f142a9",
"country_code": "GH"
}
Responses
| Status | Description |
|---|---|
200 |
Verification result. Check is_verified for the outcome. |
400 |
No account identifier supplied, or the identifier failed format validation. |
200 response
True when the account resolved with the institution.
Resolved account holder name. Present when is_verified is true.
Possible values: active, inactive, blocked
Candidate institutions that matched the identifier. Returned when is_verified is false so the caller can disambiguate and retry.
400 response
Authorization
- ApiKeyAuth