API REFERENCE
Consents
Create a Consent
3min
Create a consent by linkToken
POST
Request
Header Parameters
Authorization
required
String
Bearer link token, it returned by the /links
Body Parameters
externalTrackId
required
String
Partners to transfer tracking information, each value must be unique
personalTaxId
required
String
The CPF of the end-user, for Personal Accounts only(If end user is personal required)
businessTaxId
optional
String
The CNPJ of the company, for Business Accounts only(If end user is business required)
institutionCode
required
String
Institution code, it returned by the /institutions
redirectURL
required
String
The URL for redirection upon successful link initialization
phone
optional
String
End user's phone, compliance needs
email
optional
String
End user's email, compliance needs
clientMetadata
optional
Object
Client metadata, recommended

The end-user completes authorization and returns to the client's page URL from the LGDP page.
- If authorization succeeds, the Klavi backend returns the redirectURL with the link_id , consent_id,external_info and external_track_id parameters
- If authorization fails, the Klavi backend returns the redirectURL with the link_id, consent_id, external_info , external_track_id ,error and error_description parameters
Name | Type | Required | Description |
|---|---|---|---|
consentId | String | Yes | Consent identify |
consentRedirectURL | String | Yes | Consent redirect URL, when the front-end of the partner requests this URL, the browser will redirect to the corresponding participant's authorization page, which will pop up the current Link web page. This url can only be accessed once, and it has 60 seconds to be accessed. If the user revokes their consent, or if their validity period has reached 60 minutes, the status will be transferred to REJECTED. Accessing this URL will also return a failure. |
expireAt | String | Yes | Consent(Specifically referring to the consensId) expire time(UTC timezone) |

Updated 29 Sep 2024
Did this page help you?