API Reference
Status PageRoadmapTestimoniesShare feedback

Initiate a new Bank Account Verification - Open Banking

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

Initiate a new Bank Account Connection Verification flow and returns a URL to redirect the user to complete the connection process.

Body Params
uri
required
length between 1 and 2000

The URL to redirect the person back to your application or website after the Bank Account Connection flow is completed.

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.

string | null
enum
Defaults to FR

The country for the Bank Account Connection flow. Only banks from that country will be offered in the flow

string | null
enum
Defaults to fr

The locale for the Bank Account Connection flow.

natural_person
object | null

Information about the natural person who owns the bank account

Responses

Updated 12 days ago

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