Create Intent

post

https://api.sandbox.tarabutgateway.io/accountInformation/v1/intent

Enables you to link your user's account by creating the consent URL which enables them to start a consent journey. The endpoint must be called from your backend/server. Note: the consent status will not be complete until the user authorizes access to his bank account information from the bank channel

♦️ To create multiple consents with different purpose statements, please check this♦️

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

user

object

required

providerType

string

Type of providers list Retail or Corporate, the defualt value is Retail

consent

object

Consent object allows you to 1.skip the financial institutions selection screen in the Connect flow by providing the providerId 2.have consent flow without UI by providing the providerId, flowType, tppDetails, and permissionsList

language

string

Connect Journey supports both English and Arabic UI, the default language is English, to invoke Arabic connect journey use the attribute language in the request body with the value AR and for English connect journey use the value EN

redirectUrl

string

required

Redirect URL for the current session (must be a valid https URL and match the redirect URL configured in the Tarabut Dev Portal)

Headers

Content-Type

string

required

Defaults to application/json

Specify the body format to JSON format

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

401Error response