First synchronization

Connect an item

It's now time to synchronize a bank account. This process will create an Item entity, which is the abstraction of the connection of a User to his Bank.

📘

Item entity

The Item can be seen as a "set of credentials". It is a connection of a User to his Bank, holding one or many accounts.

The Bridge Connect is completely hosted as a web application by Bridge.
The following endpoint returns the URL to the funnel, with a token identifying your App and the User:

curl "https://api.bridgeapi.io/v2/connect/items/add" \
    -X POST \
  -H 'Bridge-Version: 2021-06-01' \
    -H 'Client-Id: MY_CLIENT_ID' \
    -H 'Client-Secret: MY_CLIENT_SECRET' \
    -H 'Authorization: Bearer TOP_SECRET_ACCESS_TOKEN' \
  -d $'{
      "country": "fr",
      "prefill_email": "[email protected]",
      }'

The response should return the URL to the Bridge Connect:

{
  "redirect_url": "https://connect.bridgeapi.io?country=fr&token_uuid=SECURE_ACCESS_TOKEN&connect_request_id=78"
}

Following the redirect_url URL will start the Bridge Connect.

📘

You can test the funnel with our demo bank named "Simulator": Test the Bridge Connect for more details.

At the end of the Bridge Connect, the user is redirected to your app's redirect url. You should have set up this parameter in the settings of your app in the Dashboard.

If the process is successful, the app’s redirect url is called with query parameters detailed in the Out of the Bridge Connect chapter.

If the process is interrupted by the user, by clicking on the "Exit" link top right, or if the synchronisation has failed, only the user_uuid will be appended to the app’s redirect url.

📘

You can use our Simulator bank to test the Bridge Connect and simulate the different types of accounts and errors you may encounter.

Bridge Connect