Connect an item

post

https://api.bridgeapi.io/v2/connect/items/add

Returns the URL to Bridge's Connect funnel for adding an item

Body Params

country

string

In the banks display, the country selector will default to the country parameter if provided. Available country codes : fr, uk, de, es, nl. If you customize the highlighted banks on the dashboard, this parameter will be inactive.

prefill_email

string

required

Used to avoid your user to fill their email in the Connect user journey.

redirect_url

string

Optional redirect URL that temporarily overrides the application's redirect URL. Only usable for sandbox applications

context

string

Optional context that will be add to the redirect url on the exit of the funnel. Only accept numbers and letters (max length 100)

bank_id

int32

If the parameter is set, your user will directly access the concerned bank credentials form (and not see the banks list). Be careful to select banks with at least the ais capability (cf. List banks)

capabilities

array of strings

Check available capabilities in the Bank resource section. If you set multiple values, the union between them is a "AND".

capabilities

Headers

Client-Id

string

required

Application's client id.

Client-Secret

string

required

Application's client secret.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400