Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Account Information

Create an account information (bank linking) session. Returns connect_url for provider UI and session_id for polling/redirect.

Create an account information (bank linking) session. Returns connect_url for provider UI and session_id for polling/redirect.

post/api/v1/merchants/{id}/account-information/sessions

Path parameters

idstring uuid required

Merchant ID

Example:123e4567-e89b-12d3-a456-426614174000

Merchant ID

Request body

countrystring

Bank account country to link. Currently only US is supported for account verification.

redirect_urlstring uri

URL to redirect the user after completing the provider flow

include_holder_identityboolean

Include account holder identity (name, address, email, phone)

include_transactionsboolean

Include transaction history

include_statementsboolean

Include PDF bank statements

statement_countnumber

Number of statements to retrieve

Example request

{
  "country": "GB",
  "redirect_url": "https://dashboard.example.com/bank-accounts/linked"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "session_id": "550e8400-e29b-41d4-a716-446655440000",
    "verification_token": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
    "expires_at": "2024-03-19T13:30:00Z"
  }
}