Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB
User management sessions

Create a user management session

User management sessions are front-end sessions that allow your users to resolve synchronization issues or add new items for the authenticated user

post/v3/aggregation/user-management-sessions

Request body

callback_urlstring url

Optional callback URL for redirecting the user at the exit of the user management session

contextstring

Optional context string to append to the callback URL when exiting the user management session. It can contain up to 100 alphanumeric characters, including the hyphen (-).

account_types'payment' | 'all'

Minimum account types required. We suggest payment to ensure the best user experience

user_emailstring email

Mandatory, except in the case of temporary bank synchronization

country_code'FR' | 'ES' | 'IT' | 'PT' | 'DE' | 'BE' | 'NL' | 'LU' | 'PL' | 'HU' | 'IE' | 'MT' | 'CZ' | 'NO' | 'BG' | 'SE' | 'DK' | 'AT' | 'SK' | 'FI' | 'GB' | 'GR' | 'EE' | 'IS' | 'CY' | 'HR' | 'LV' | 'RO'

On the displayed providers list, the country selector will default to the country parameter if provided. If you customize the highlighted banks on the dashboard, this parameter will be disabled.

capabilitiesstring[]

Filter the provider capabilities you need. When multiple values are specified, they are combined using an AND operation

allow_account_selectionboolean

Allow or disallow the selection of the accounts

show_add_item_buttonboolean

Indicates whether the button for adding an item should be rendered in the UI.

Example request

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

Response

User management session created

idstring required

User management session identifier

urlstring url required

User management session web funnel URL

Example response

{
  "id": "bf8f3e2a-6b04-412a-b2a3-be7fef470b4a",
  "url": "https://connect.bridgeapi.io/user/e953f3c4-d7d9-4161-a50a-f92f330d08ea"
}