Skip to main content
POST
curl
Your backend sends the name and the account, and reads the result. It is the account check of the Bank Verification step, without the person.

Send the account the way its country writes it

Some countries also ask for a bic, and for a business account a registration_id. Spaces, dashes and dots are ignored. A key the country’s check needs and does not get is a 400 naming it, for example "field": "account.sort_code", "reason": "required". Send holder.full_name to check a person’s account, or holder.business_name to check a company’s.

Read the result

Billing and retries

Each check the bank answers is billed once at the Account check price of the account’s country, whatever the result. A request answered with an error is never billed: a refused body (400), no credit (402), an account no check serves yet (404) or a bank that could not answer (503). There is no idempotency key and no endpoint to read a check back. A retried request runs a new check, with a new request_id, and is billed again, so store the response. Didit stores only the charge, with the request ID, the country, the result and the masked account, never the name or the full account number.

Test it in sandbox

A sandbox API key calls no bank and is charged nothing. The last 4 characters of the IBAN, else of the account number, choose the answer: An IBAN, a CLABE and a CBU carry check digits: use the sandbox values that pass every format check.

Access

Authenticate with your application’s x-api-key, or with its client-credentials bearer token. A scoped API key needs write access to sessions. The endpoint shares the write limit of 300 requests per minute per API key.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Body

application/json
country
string
required

The account's country, as an ISO 3166-1 alpha-3 code, for example GBR. Lowercase is accepted.

Required string length: 3
Example:

"GBR"

account
object
required

The account the way its country writes it: an iban, or an account_number with the bank or branch code the country needs (sort_code, routing_number, transit_institution, bsb, ifsc, bank_code or bic). Mexico takes a clabe and Argentina a cbu_cvu, which already name the bank. A business account adds a registration_id where the country asks for one. Spaces, dashes and dots are ignored. Keys the country's check does not use are ignored; a key it needs and does not get is a 400 that names it.

Example:
holder
object
required

The name the account is checked against. Send exactly one of full_name and business_name.

vendor_data
string | null

Your own reference for this check, returned unchanged.

Example:

"payout_20481"

Response

The bank answered. The check is billed, whatever the result.

request_id
string<uuid>
required

The ID of this check.

result
enum<string>
required

match: the bank holds the account under the name you sent. close_match: under a close name, for example a missing middle name or a typo. no_match: under another name, or there is no such account. cannot_verify: the bank answered without comparing the name, for example for a blocked or closed account.

Available options:
match,
close_match,
no_match,
cannot_verify
holder_name
string | null
required

Only on a close_match, and only when the bank returned it: the name on the account, as the bank holds it. null otherwise.

account
string
required

The account, masked to its last 4 characters.

vendor_data
string | null
required

Your own reference, as you sent it.

created_at
string<date-time>
required

When the check ran, in UTC.