API Reference
Status PageRoadmapTestimoniesShare feedback

Initiate a new Bank Account Lookup Verification

post
https://api-sandbox.yousign.app/v3/verifications/bank_account_lookups

Initiate a new Bank Account Lookup Verification to check if a bank account exists and belongs to the specified person or company.

Related guide: Bank Account Verification

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

  • 📝 application/json — provide the natural person's bank account details directly, or reference an existing Workflow Session Applicant by ID.
  • 📁 multipart/form-data — upload a binary file containing the natural person's bank account details.

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: pro, scale
  • Add-ons (for production access): Verify - Bank account verification
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The International Bank Account Number (IBAN) to verify. The IBAN must be a valid IBAN starting with "FR". The IBAN must belong to a bank that is a member of the SEPAmail DIAMOND network.

natural_person
object
required

Information about the natural person who owns the bank account

uuid | null

Scopes the verification to a specific workspace. Defaults to the default workspace if not specified.

uuid | null

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

uuid | null

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.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 10 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago