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
`verification.bank_account_connection.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": "verification.bank_account_connection.done",
  "event_time": "1348177752",
  "subscription_id": "d09f0367-d80a-309c-a2ed-7083991fc564",
  "subscription_description": "A great webhook",
  "sandbox": false,
  "data": {
    "bank_account_connection": {	 
      "id": "f2e1fef6-0c11-46c5-80df-8aebfdfba774",
      "workspace_id": "67536e37-c15e-4883-88bd-94a3057a6adb",
      "created_at": "2025-07-24T13:35:07+00:00",
      "updated_at": "2025-07-24T13:36:34+00:00",
      "status": "verified",
      "status_codes": [],
      "data_anonymized": false,
      "verification_url": "https://api.yousign.app/verifications/bank_account_connection_verifications/f2e1fef6-0c11-46c5-80df-8aebfdfba774/start?s=e15fbe2b1d424c01a33ccd5b0e7fc9e20d34272be87a239cf189118a97a4ad53346688a90718062d42aabd3ffba9d67350954904e61a40560819cc4cebaa38a8&r=1CpNACB_Dke0oQ%3D%3D",
      "data": {
          "account_type": "personal",
          "account_identifiers": {
              "iban": "FR3030003000402399488286P87",
              "bic": null
          },
          "bank_name": "Demo Bank",
          "parties": [
              {
                  "role": "HOLDER",
                  "full_name": "John Doe",
                  "legal_person_name": null
              },
              {
                  "role": "AUTHORIZED_USER",
                  "full_name": "Jane Doe",
                  "legal_person_name": null
              },
              {
                  "role": "OTHER",
                  "full_name": "Bob Doe",
                  "legal_person_name": null
              },
              {
                  "role": "UNKNOWN",
                  "full_name": "Anne Doe",
                  "legal_person_name": null
              }
          ]
      }
    }
  }
}

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 connection verification.

GET /verifications/bank_account_connections/{id}

{
    "id": "f2e1fef6-0c11-46c5-80df-8aebfdfba774",
    "workspace_id": "67536e37-c15e-4883-88bd-94a3057a6adb",
    "created_at": "2025-07-24T13:35:07+00:00",
    "updated_at": "2025-07-24T13:36:34+00:00",
    "status": "verified",
    "status_codes": [],
    "data_anonymized": false,
    "verification_url": "https://api.yousign.app/verifications/bank_account_connection_verifications/f2e1fef6-0c11-46c5-80df-8aebfdfba774/start?s=e15fbe2b1d424c01a33ccd5b0e7fc9e20d34272be87a239cf189118a97a4ad53346688a90718062d42aabd3ffba9d67350954904e61a40560819cc4cebaa38a8&r=1CpNACB_Dke0oQ%3D%3D",
    "data": {
        "account_type": "personal",
        "account_identifiers": {
            "iban": "FR3030003000402399488286P87",
            "bic": null
        },
        "bank_name": "Demo Bank",
        "parties": [
            {
                "role": "HOLDER",
                "full_name": "John Doe",
                "legal_person_name": null
            },
            {
                "role": "AUTHORIZED_USER",
                "full_name": "Jane Doe",
                "legal_person_name": null
            },
            {
                "role": "OTHER",
                "full_name": "Bob Doe",
                "legal_person_name": null
            },
            {
                "role": "UNKNOWN",
                "full_name": "Anne Doe",
                "legal_person_name": null
            }
        ]
    }
}

Similar to the webhook, you will receive the verification status and any associated error codes (if the verification was failed or inconclusive). For more information on the statuses and error codes, refer to this section.

This endpoint also returns 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": "75ad36cc-7e0f-464c-9241-569282c1cedc",
    "workspace_id": "67536e37-c15e-4883-88bd-94a3057a6adb",
    "created_at": "2025-07-24T13:01:55+00:00",
    "updated_at": "2025-07-24T13:01:55+00:00",
    "status": "verified",
    "status_codes": [],
    "data_anonymized": true,
    "verification_url": "https://api.yousign.app/verifications/bank_account_connection_verifications/75ad36cc-7e0f-464c-9241-569282c1cedc/start?s=80b03a2fb3c06c3e4b31b6c031b2e1aeac8a7df4ea41854ae4adf8a14606aecaf9e590fd0cca3411af035f7d3701e340fa46d2361c4c9518de9f2f1c8ec43a67&r=CY9cqLQRmtAN1A%3D%3D",
    "data": {
        "account_type": "business",
        "account_identifiers": {
            "iban": null,
            "bic": null
        },
        "bank_name": null,
        "parties": []
    }
}

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 /verifications/bank_account_connections

{
    "meta": {
        "next_cursor": null
    },
    "data": [
        {
            "id": "75ad36cc-7e0f-464c-9241-569282c1cedc",
            "workspace_id": "f2d23c03-4a21-4fb5-a3ea-d207905a0d62",
            "created_at": "2025-07-24T13:01:55+00:00",
            "updated_at": "2025-07-24T13:01:55+00:00",
            "status": "pending",
            "status_codes": [],
            "data_anonymized": false
        }
    ]
}