🚧

Pre- requisite

Generate a token using the Generate Access Token endpoint.

Create a customer intent

Use the Create Intent API to allow your customers to initiate the account linking process by creating an intent.

It is required to pass a value uniquely identifying a customer to Tarabut. The customer identifier value should be passed in the customerUserId attribute in the user object.

👍

It is recommended not to pass any PII (Personal Identifiable Information) as the value for customerUserId

Incase multiple redirect URLs are set up in the portal, ensure to pass one of the URLs in the request. Once the linking is completed Tarabut will make a callback to the redirect url used during intent creation.

curl --location --request POST 'https://api.sandbox.tarabutgateway.io/accountInformation/v1/intent' \
--header 'Authorization: Bearer <your_access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": {
        "customerUserId": "7982364",
        "email": "[email protected]"
        "firstName": "John",
        "lastName": "Snow",
    },
  "consent":{
    "providerId": "BLUE"
  },
    "redirectUrl": "http://override.me/notDefault"
}'

A successful Create Intent returns a Connect URL in the response. The Connect URL loads a web view that guides your end user through the consent journey.

{
  "connectUrl": "https://connect.sandbox.tarabutgateway.io/launch/?....",
  "intentId": "092d24cc-4691-460d-a33b-f54f0b26403c",
  "expiry": "2022-04-06T16:30:00Z"
}

📘

Note

The API should be called from your backend/server and it returns a connect url, which starts the consent journey for an end-user.

An intent is not complete until the user authorises consent at the bank to access their account(s)