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

Exposed resources

The data model is based on six main entities.

Bridge is a Server-to-Server API. You need to map our entities detailed below with your data structure.

  • Users belong to your application (App). The User entity is an abstraction of an end-user. The User is identified by its uuid and should be linked in your backend to your abstraction of a User / Client.
    See the User resource.

  • Items belong to a User. The Item entity is the abstraction of the connection of the end-user to a Bank. One item corresponds to one set of bank credentials.
    See the Item resource.

  • Accounts belong to an Item. The Account entity represents a real life account (e.g., a Checking Account).
    See the Account resource.

  • Transactions belong to an Account. The Transaction entity represents a real life transaction.
    See the Transaction resource.

  • Stocks belong to an Account. The Stocks entity represents a real life stock.
    See the Stock resource.

The relational model of the ressources is described below.

Updated 10 months ago

Exposed resources

Suggested Edits are limited on API Reference Pages

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