Create a user management session

post

https://api.bridgeapi.io/v3/aggregation/user-management-sessions

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

Body Params

callback_url

url

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

context

string

length ≤ 100

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

string

enum

Defaults to payment

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

Allowed:

user_email

string

Mandatory, except in the case of temporary bank synchronization

country_code

string

enum

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.

capabilities

array of strings

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

capabilities

allow_account_selection

boolean

Allow or disallow the selection of the accounts

Headers

Bridge-Version

string

enum

required

Defaults to 2025-01-15

The Bridge API version

Allowed:

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/json

201User management session created

400Error 400

401Error 401