Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB
Connect sessions

Create a connect session

Connect sessions are front-end sessions that allow your user to connect or update their bank connection

post/v3/aggregation/connect-sessions

Request body

OR
OR

Example request

{
  "user_email": "email@gmail.com",
  "country_code": "FR",
  "allow_account_selection": true,
  "max_selectable_accounts": 10,
  "callback_url": "https://yourcallback.com",
  "context": "abc123",
  "account_types": "payment"
}

Response

Connect session created

idstring required

Connect session identifier

urlstring url required

Connect session web funnel URL

Example response

{
  "id": "bf8f3e2a-6b04-412a-b2a3-be7fef470b4a",
  "url": "https://connect.bridgeapi.io/session/09486392-9e19-4045-a758-65daea24aes9"
}