---
title: "Create a connect session"
method: POST
path: "/v3/aggregation/connect-sessions"
tags: ["Connect sessions"]
---

# Create a connect session

`POST /v3/aggregation/connect-sessions`

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

## Request body

- union
  - CreateConnectSessionNewItem
    - `user_email` string, 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.
    - `capabilities` string[] — Filter the provider capabilities you need. When multiple values are specified, they are combined using an `AND` operation
    - `allow_account_selection` boolean — Allow or disallow the selection of the accounts
    - `max_selectable_accounts` number — Max selectable accounts to be synchronized
    - `callback_url` string, url — Optional callback URL for redirecting the user at the exit of the connect session
    - `context` string — Optional context string to append to the callback URL when exiting the connect 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
  - CreateConnectSessionNewItemPreselectedProvider
    - `user_email` string, email — Mandatory, except in the case of temporary bank synchronization
    - `provider_id` number — If the parameter is set, the user will be directed straight to the relevant provider's authentication page (bypassing the providers list). Be sure to select a provider that supports at least the aggregation capability (see 'List providers')
    - `allow_account_selection` boolean — Allow or disallow the selection of the accounts
    - `max_selectable_accounts` number — Max selectable accounts to be synchronized
    - `callback_url` string, url — Optional callback URL for redirecting the user at the exit of the connect session
    - `context` string — Optional context string to append to the callback URL when exiting the connect 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
  - CreateConnectSessionManageItem
    - `item_id` number, required — The item for which you want to manage its connection state
    - `force_reauthentication` boolean — Set this value to true if you want to renew the SCA immediately
    - `allow_account_selection` boolean — Allow or disallow the selection of the accounts
    - `max_selectable_accounts` number — Max selectable accounts to be synchronized
    - `callback_url` string, url — Optional callback URL for redirecting the user at the exit of the connect session
    - `context` string — Optional context string to append to the callback URL when exiting the connect 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

## Response `201`

Connect session created

- ConnectSession — Create connect sessions to make your user connect or update their bank connection
  - `id` string, required — Connect session identifier
  - `url` string, url, required — Connect session web funnel URL

## Other responses

- `400` — Error 400
- `401` — Error 401

---

[API](https://skmtc.dev/bridgeapi/apis/bridge-api.md) · [All operations](https://skmtc.dev/bridgeapi/apis/bridge-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bridgeapi/bridge-api/revisions/9b9ad8010fd5/schema)