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

User creation

The registration of a user requires an email and a password.

🚧

The end user, who will synchronize his bank accounts, doesn't need to be aware of these two parameters.

Bridge is a Server-to-Server API, so you can use the email parameter like an identifier and the password should be generated randomly. If you lose this password, the API cannot regenerate it.

📘

Email parameter

It doesn't have to be a real email although the "@" is required. Please also note that the email (and all query parameters) should be URL Encoded (@ becomes %40), otherwise the request will fail.

📘

Password parameter

Must be at least 6 characters and less than 72 characters.

🚧

User lifecycle management

Don't forget to delete the Bridge users associated to your customers when they delete their account on your service.

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"
    }'

Updated 5 months ago


User creation


Suggested Edits are limited on API Reference Pages

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