Language Support for Connect

📘

Overview

A key guideline to provide a well-designed experience is to ensure there is maximum transparency. The experience must enable a user to make an informed decision and also understand the consequences of that decision. To that end, it is imperative that the user journey is provided in the language preferred by the customer application.

The Connect journey can be rendered in both English and Arabic as preferred by the customer. The Create intent endpoint which returns the Connect URL needs to be invoked as follows to generate the Connect journey in the preferred language.

To render the Connect flow in English

The default behaviour of the endpoint is to generate the Connect journey in English unless specified in the API request.

To render the Connect flow in Arabic

Include the attribute language in the request body when invoking the Create Intent API.

curl --location --request POST 'https://api.sau.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",
    "userIdentifier": {
      "type": "",
      "value": ""
    }
  },
  "consent":{
    "providerId": "BLUE"
  },
  "redirectUrl": "http://override.me/notDefault",
  "language": "AR"
}'

👍

Good to know

Ensure you provide the translated version of your display name to Tarabut when onboarding so all the Connect screens display correctly.