Bridge API Documentation

Bridge Documentation

Welcome to our API documentation!

We're happy to share with you our new API 2021 version! Please check our Product Changelog to see the main updates.

You'll find comprehensive guides and documentation to help you start integration Bridge API as quickly as possible, as well as support if you get stuck.

Let's jump right in!

Get Started

Your first Account Check

User Creation

You need to create a user for each customer you want to Account Check.

📘

Please note that the email must be URL Encoded (@ becomes %40) and the password must be at least 6 characters and less than 72 characters.

curl 'https://api.bridgeapi.io/v2/users' \
    -X POST \
    -H 'Bridge-Version: 2021-06-01' \
    -H 'Content-Type: application/json' \
    -H 'Client-Id: MY_CLIENT_ID' \
    -H 'Client-Secret: MY_CLIENT_SECRET' \
    -d $'{
    "email": "[email protected]",
    "password": "password123"
    }'

Please check the Create a user API reference or our guide on user creation for more details.

User Authentication

The User resource is an abstraction of the end user, you will need to authenticate him in a Server-to-Server way. That means no action from the end user is needed.

curl 'https://api.bridgeapi.io/v2/authenticate' \
    -X POST \
    -H 'Bridge-Version: 2021-06-01' \
    -H 'Content-Type: application/json' \  
    -H 'Client-Id: MY_CLIENT_ID' \
    -H 'Client-Secret: MY_CLIENT_SECRET' \
    -d $'{
    "email": "[email protected]",
    "password": "password123"
    }'

The API response contain the access_token that you must provide in your next authenticated calls, using the bearer authentication scheme with the header Authorization.

Please check the Authenticate a user API reference for more details.

Bridge Connect

The Bridge Connect is a Bridge hosted page where your customer can connect his bank account.

The following endpoint returns an URL to the hosted page where only banks supporting the Account Check feature will be displayed to your customer:

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 $'{
      "capabilities": ["account_check"]
      }'

Please check the Bridge Connect API reference for more details.

Get accounts information

Once the bank connection has been made, the user will be redirected to your callback URL (cf. Out of the Bridge Connect).

🚧

Users who close the Bridge Connect tab won't be redirected on your callback URL. Use our Webhooks to know if the item has been created.

Then you can retrieve the accounts information of your user:

curl "https://api.bridgeapi.io/v2/accounts-information" \
    -X GET \
    -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'

This endpoint only displays account where first_name, last_name and IBAN are available.

{
  "resources": [
    {
      "item_id": 5869768,
      "first_name": "JEAN",
      "last_name": "DUPONT",
      "accounts": [
        {
          "id": 27341559,
          "name": "Compte Courant de MR DUPONT",
          "type": "checking",
          "currency_code": "EUR",
          "bank_id": 6,
          "iban": "FR3312739000309854725191G90"
        }
      ]
    }
  ]
}

Please check the Get accounts information API reference for more details.

Updated 14 days ago


Your first Account Check


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.