Skip to main content
POST
Verify IBAN Holder

Testing in Sandbox

The Sandbox environment mirrors the Production API but allows you to control the verification outcome using the sandbox_result field. This is essential for testing how your application handles different business logic scenarios (matches, mismatches, or errors).
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

Any valid IBAN structure works in sandbox. Examples:

Unlimited sandbox requests

โœ… No account credits consumed โœ… Same authentication as production

Going Live

Once testing is complete:
  1. Switch from /sandbox/account-holder-verifications
    to /account-holder-verifications
  2. Remove the sandbox_result parameter
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>
default:match

Force a specific outcome for testing purposes.

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 failedstatus 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 statusis 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
string
read-only

Additional context on the request status. Primarily populated when status is 'failed' or when match_result is 'account_not_verifiable'

Example:

"institution_timeout"

enrichment
object
read-only