User Creation and 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

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

curl --request POST \
     --url https://api.bridgeapi.io/v3/aggregation/authorization/token \
     --header 'Bridge-Version: BRIDGE_VERSION' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "user_uuid": "c2a26c9e-dc23-4f67-b887-bbae0f26c415"
}
'

curl --request POST \
     --url https://api.bridgeapi.io/v3/aggregation/authorization/token \
     --header 'Bridge-Version: BRIDGE_VERSION' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "external_user_id": "A6JEJIID1919BDS"
}
'

Then, when you authenticate the user, the API response contains the access_token that you must provide in your next authenticated calls, using the bearer authentication scheme with the header Authorization.

curl --request POST \
     --url https://api.bridgeapi.io/v3/aggregation/authorization/token \
     --header 'Bridge-Version: BRIDGE_VERSION' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "user_uuid": "c2a26c9e-dc23-4f67-b887-bbae0f26c415"
}
'

curl --request POST \
     --url https://api.bridgeapi.io/v3/aggregation/authorization/token \
     --header 'Bridge-Version: BRIDGE_VERSION' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "external_user_id": "A6JEJIID1919BDS"
}
'

Please check User creation and authentication for more details.

Create a Connect session

The following endpoint returns the URL of the Connect session where only banks supporting Account Check will be displayed:

curl --request POST \
     --url https://api.bridgeapi.io/v3/aggregation/connect-sessions \
     --header 'Bridge-Version: BRIDGE-VERSION' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'Authorization: Bearer TOP_SECRET_ACCESS_TOKEN' \
     --data '
		{
  		"capabilities": ["account_check"]
		}
		'

{
  "id": "bf8f3e2a-6b04-412a-b2a3-be7fef470b4a",
  "url": "https://connect.bridgeapi.io/session/09486392-9e19-4045-a758-65daea24aes9"
}

Please check First synchronization for more details.

Get accounts information

Once the bank connection has been made, you can retrieve the accounts information of your user:

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

curl --request GET \
     --url https://api.bridgeapi.io/v3/aggregation/accounts-information \
     --header 'Bridge-Version: BRIDGE-VERSION' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header '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",
          "provider_id": 6,
          "iban": "FR3312739000309854725191G90"
        }
      ]
    }
  ]
}

For business account, you will find first and last name of the person who owns the bank credentials.