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

Items statuses

An item represents a connection to a bank account using a set of user credentials.
It contains one or more accounts which contain transactions.

The status of an item is detailed thanks to three fields :

  • status
  • status_code_info
  • status_code_description

Please request the rights to this file for full detail.

Status

Status

Description

0

Everything is awesome.

402

Wrong credentials.

429

An action from the user is required within the online banking of the user.

Examples:
The user needs to accept new ToS, change his credentials, first time connecting to the bank's website, ...

430

The User needs to log onto his bank's website to change his password.

1003

Couldn't refresh. Try again.

1005

Account not supported.

1007

Refresh temporarily disabled.

1009

Account balance has changed but no new transactions were found.
This may happen with stock / life insurance accounts.

1010

Item wasn't refreshed successfully, it required an MFA / OTP that wasn't provided, see Strong Customer Authentication.

1099

Item is being migrated to another bank.

1100

Pro accounts have been detected on this Item and it needs validation. Otherwise the data will be obfuscated.

status_code_info and status_code_description

Status

Status code info

402

INVALID_CREDS
WRONG_ID
WRONG_ID_FORMAT
WRONG_PWD
WRONG_PWD_FORMAT
WRONG_PWD2
WRONG_PWD2_FORMAT
ACCOUNT_TEMPORARILY_BLOCKED
ACCOUNT_BLOCKED
ACCOUNT_BLOCKED_CONTACT_BANK

429

TOS_TO_VALIDATE
CONTRACT_TO_SIGN
INACTIVE_CREDS
ACCOUNT_TO_ACTIVATE
PHONE_NB_TO_CONFIRM
INFORMATION_TO_REVIEW
SMTH_TO_VALIDATE
OTP_REGISTRATION_TO_DO
KYC_TO_FILL
AMLCFT_DATA_TO_CONFIRM
PHONE_NB_TO_SET
PERSO_DATA_TO_CONFIRM
FORM_TO_FILL
READONLY_ACCESS_TO_CREATE
CANNOT_ACCESS_SERVICES
NO_ONLINE_ACCESS
CREDS_UPDATE_MESSAGE
UNLOCK_OTP_IN_APP
UNLOCK_OTP_IN_WEB
CONTACT_BANK
EXPIRED_ID_CONTACT_BANK
NO_ACCESS_CONTACT_BANK
INACTIVE_CREDS_CONTACT_BANK
PWD_RENEWAL
PWD_RENEWAL_FIRST_CO
PWD_RENEWAL_READONLY_ACCESS

1003

CNT_CRASH
LOGIN_CRASH
INVALID_CREDS
BANK_IS_DOWN
NO_ACCOUNT_FOUND

1005

OTP_NOT_SUPPORTED
PRO_NOT_SUPPORTED
PART_IN_PRO_CNT
WRONG_COUNTRY_OR_AREA
MIGRATION_TO_NEW_BANK
NO_ACCESS_TO_ACCOUNT
SUSPENDED_ACCESS
CLOSED_ACCOUNT
NO_ONLINE_ACCESS

1010

OTP_REQUIRED
OTP_FAILED
WRONG_OTP
EXPIRED_DEVICE
INVALID_PHONE_NB
BLOCKED_LIMIT_REACHED
BLOCKED_SMS_LIMIT_REACHED
OTP_NOT_SUPPORTED

The status_code_description are the messages displayed to the users for each status_code_info detailed above.

Item resource example

{
  "id": 187791,
  "status": 1010,
  "status_code_info": "OTP_REQUIRED",
  "status_code_description": "Please fill in the strong customer authentication (SMS, notification, etc.) provided by your bank",
  "bank": 408
}

Updated 3 months ago

Items statuses


Suggested Edits are limited on API Reference Pages

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