Retrieve bank account verification results
On this page, you will learn how to retrieve detailed information about a processed bank account verification.
Get bank account verification results via Webhooks
Webhooks provide an efficient way to get notified when a bank account verification has been completed, and to retrieve the related verification results.
For more details on setting up and managing Webhooks, please refer to this dedicated section.
To receive those notifications, subscribe to the following event:
Event | Description |
---|---|
bank_account_verification.done | Triggered when a bank account verification is complete |
Example Webhook Payload for an approved bank account verification:
{
"event_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
"event_name": "bank_account_verification.done",
"event_time": "1348177752",
"subscription_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
"subscription_description": "A great webhook",
"sandbox": false,
"data": {
"bank_account_verification": {
"id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
"status": "approved",
"status_codes": [ ]
}
}
For more information on the statuses and error codes, refer to this section.
Retrieve detailed bank account verification results
You can also obtain detailed verification results by calling a dedicated endpoint, with the id
returned when requesting a bank account verification:
GET /bank_account_verifications/{id}
{
"id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
"status": "approved",
"status_codes": [],
"extracted_from_document": {
"iban":"FR7614278030060001478474080",
"bic":"CMCIFR2B"
},
"personal_data_anonymized": false
}
Similar to the webhook, you will receive the verification status and any associated error codes if the verification was declined
. For more information on the statuses and error codes, refer to this section.
This endpoint returns also the data extracted from the bank account details, such as the IBAN or the BIC.
After 7 days, bank account verification records are anonymized, meaning all personal or sensitive data associated with the verification request is permanently deleted.
If you attempt to retrieve any verification details beyond this retention period, fields containing sensitive data will return null
, and the personal_data_anonymized
parameter will be set to true
:
{
"id": "a08d2986-2b7f-439c-9f10-d8d65b06bb9d",
"status": "approved",
"status_codes": [],
"extracted_from_document": {
"iban":null,
"bic":null
},
"personal_data_anonymized": true
}
List all bank account verification requests
To retrieve a list of all verification requests, you can call the following endpoint. You can filter by status or paginate the results based on your needs:
GET /bank_account_verifications
{
"meta": {
"next_cursor": "string"
},
"data": [
{
"id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
"status": "pending",
"status_codes": [],
"created_at": "2025-01-21T15:59:19+00:00",
"updated_at": "2025-01-21T15:59:21+00:00"
}
]
}
Updated 14 days ago