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 know the main changes.

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

Let's jump right in!

Get Started

Dashboard

The dashboard is the interface where you can create sandbox applications and configure and manage all your Bridge applications.

Home PageHome Page

Home Page

To begin using the API, you need to create an account to the dashboard on the Bridge website: https://dashboard.bridgeapi.io/signup.

Sign up PageSign up Page

Sign up Page

Create a Sandbox Application

First you need to configure the settings of your app:

  • Internal name: the internal name of your application, it won't be shown to your users.
  • Redirect URL: the page where you want to redirect your user at the end of the synchronization, after the funnels Bridge Connect and Bridge Transfer.
  • Authorized IPs: the IPs which are allowed to call the Bridge API with your API credentials.
Step 1 - SettingsStep 1 - Settings

Step 1 - Settings

❗️

Only allow known IPs to call the API using your application's credentials.

Next, you can customize your app:

  • Display name: the name of the application you want to communicate to your users. This name will be part of the funnel Bridge Connect.
  • Logo: the logo you want to show to your users in the funnels Bridge Connect, Bridge Transfer and Payment Links.
  • Highlighted banks: the banks which will be highlighted in the Bridge Connect (when your user selects a bank account to synchronize)
Step 2 - CustomizationStep 2 - Customization

Step 2 - Customization

Then you get your API credentials!

Step 3 - API CredentialsStep 3 - API Credentials

Step 3 - API Credentials

Updated about a month ago


What's Next

API credentials

Dashboard


Suggested Edits are limited on API Reference Pages

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