Get a Consent

1 min

consents

Get a consent by its consentId

GET

https://api-sandbox.klavi.ai/data/v1/consents/{consentId}

Header Parameters

Authorizationstringrequired
Description
Bearer access token, it returned by the /auth

Response

consentIdstring
Description
Consent identify
linkIdstring
Description
Unique Link
externalTrackIdstring
Description
Partners to transfer tracking information
personalTaxIdstring
Description
The CPF of the end-user, for Personal Accounts only
businessTaxIdstring
Description
The CNPJ of the company, for Business Accounts only
institutionCodestring
Description
Institution code, it returned by the /institutions
statusstring
Description
STARTED - Consent created; AWAITING_AUTHORISATION - Waiting for end-user authorization; AWAITING_LGPD_AUTHORISATION - Waiting for end-user LGPD acceptance; (required for Financial Data) AUTHORISED - Consent authorized by the end-user (valid status to call data endpoints); ERROR - There was an issue in the consent authorization flow REJECTED - End-user rejected the consent authorization EXPIRED - Consent expired by timeout (inactive for 30 minutes) REVOKED - Consent revoked (can be revoked by the end-user or the application) DELETED_BY_USER - End-user requested data deletion
permissionsApplystring
Description
The permission required by partners for end-user
permissionsGrantedstring
Description
The permissions granted by end-users
expireAtstring
Description
Consent expire time(UTC time)
createdAtstring
Description
Create consent time(UTC time)
updatedAtstring
Description
Update data time(UTC time)

curl

curl --location --globoff 'https://api-sandbox.klavi.ai/data/v1/consents/{consentId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

200

{
    "consentId": "ac246093-353b-4310-bd9c-c6ce0b278de8",
    "linkId": "85a3af9f-e8ab-4be8-86dd-6138e9f2474c",
    "externalTrackId": "113ee41e-1ecf-41b7-b6a9-c24d7f84bdfd",
    "personalTaxId": "16109277672",
    "businessTaxId": "",
    "institutionCode": "001",
    "status": "AUTHORISED",
    "permissionsApply":
    [
        "ACCOUNTS_ALL",
        "CREDIT_CARDS_ALL",
        "CREDIT_OPERATIONS_ALL",
        "REGISTRATION_ALL",
        "INVESTMENTS_ALL"
    ],
    "permissionsGranted":
    [
        "ACCOUNTS_ALL",
        "CREDIT_CARDS_ALL",
        "CREDIT_OPERATIONS_ALL",
        "REGISTRATION_ALL",
        "INVESTMENTS_ALL"
    ],
    "expireAt": "2024-12-07T23:59:59.999Z",
    "createdAt": "2023-12-08T09:19:19.253Z",
    "updatedAt": "2023-12-08T11:29:50.253Z"
}