Skip to main content
POST
Verify IBAN Holder

Testing in Sandbox

The Sandbox mirrors the Production API without querying real banks. The outcome is determined by the IBAN you send: use one of the test IBANs below to trigger a specific result. Any other IBAN with a valid format returns match. You can also force the outcome with the optional sandbox_result field. When provided, it takes priority over the IBAN.
Note: No real bank queries are performed in the Sandbox. All IBANs are accepted as long as they follow the standard IBAN format.

Authentication

Use the same OAuth endpoint for both production and sandbox.

Triggering Specific Outcomes

Use the sandbox_result parameter in your request body to force the API to return a specific state.

Sandbox Example Request


Test IBANs

These IBANs are fictitious but have valid check digits. Each one always returns the same result. All return status: completed, except failed.
For close_match, account_holder.name is required. The failed IBAN returns status_reason: verification_not_possible. Any other IBAN with a valid format returns match.

Unlimited sandbox requests

✅ No account credits consumed ✅ Same authentication as production

Going Live

Once testing is complete:
  1. Change the endpoint from /sandbox/account-holder-verifications to /account-holder-verifications.
  2. If you used sandbox_result, remove it. If you only used test IBANs, your request body is already production-ready.
That’s it!

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
account
object
required
account_holder
object
required
sandbox_result
enum<string>

Forces the sandbox outcome. Allowed values: match, no_match, close_match, failed. When provided, it takes priority over the test IBAN. When omitted, the outcome is determined by the IBAN (see Test IBANs); any other IBAN returns match.

Available options:
match,
no_match,
close_match,
failed

Response

Verification completed

id
string<uuid>
read-only
Example:

"abc123ab-3171-4e97-92ec-a11e9fabc123"

status
enum<string>
read-only

The current lifecycle state of the verification request.

A completed status indicates that the financial institution has been successfully reached and processed the request.

A failed status indicates that the verification could not be completed due to technical or institutional constraints.

Additional details may be provided in the status_reason field.

Available options:
pending,
completed,
failed
match_result
enum<string>
read-only

The outcome of the account holder name verification against the financial institution’s records. Provided only when status is completed.

Available options:
match,
close_match,
no_match,
account_not_verifiable
matched_name
string
read-only

Indicates the full name or company name as registered by the financial institution. Provided only if 'match_result' is 'close_match' and in accordance with data privacy regulations.

Example:

"JEAN DUPONT"

status_reason
enum<string>
read-only

Additional context provided when the verification could not be completed.

Available options:
institution_out_of_scope,
institution_timeout,
unsupported_characters,
verification_not_possible
Example:

"institution_timeout"

enrichment
object
read-only