Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Bank Account Verification

Initiate a new Bank Account Verification

Ask for a Bank Account Verification by sending the file containing the bank account details, such as IBAN and BIC.

A Bank Account Verification can be requested as follows:

  • Bank Account verification: This option only checks the validity of the Bank Account document.
  • Bank Account verification with legal person: This option checks both:
    • the validity of the Bank Account document
    • the coherence between the provided legal person names and those on the document.
  • Bank Account verification with natural person: This option checks both:
    • the validity of the Bank Account document
    • the coherence between the provided natural person names and those on the document.

Related guide: Bank Account Document Verification

ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:

  • 📁 multipart/form-data — upload a binary file containing the bank account details (IBAN/BIC).
  • 📝 application/json — reference an existing Workflow Session Applicant by ID.

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: pro, scale
  • Add-ons (for production access): Verify - Bank account document check
post/verifications/bank_accounts

Request body

applicant_idstring uuid required

The Applicant ID linked to the Workflow Session.

Example request

{
  "applicant_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
}

Response

Created

idstring uuid required

The unique identifier for a resource.

workspace_idstring uuid

The Workspace ID in which the verification has been created.

created_atstring date-time required

Creation date of the Bank Account Verification.

updated_atstring date-time required

Update date of the Bank Account Verification.

status'pending' | 'awaiting_data' | 'verified' | 'failed' | 'inconclusive' required

Status of the Bank Account Verification.

status_codesstring[] required

List of status codes. Indicates the cause when the status is failed or inconclusive.

data_anonymizedboolean required

Indicates if the personal data extracted from the document has been anonymized. If set to true, the personal data has been anonymized and most fields will be NULL.

workflow_session_idstring uuid nullable required

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

previous_attempt_idstring uuid nullable required

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

applicant_idstring uuid nullable required

Unique identifier of an Applicant.

Example response

{
  "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "workspace_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "created_at": "2025-02-12T23:59:59Z",
  "updated_at": "2025-02-12T23:59:59Z",
  "status": "verified",
  "status_codes": [
    "BAV_1604",
    "BAV_1611"
  ],
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4",
  "applicant_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "data": {
    "extracted_from_document": {
      "iban": "FR7610278030060001478474080",
      "bic": "CMCIFR2A"
    }
  }
}