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:

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"
    }
}

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.

Data management

The data stored during bank account verifications is retained for 7 days, after which it is deleted.