Get a Consent

2min

Get a consent by its consentId
GET
Request
Header Parameters
Authorization
required
String
Bearer access token, it returned by the /auth
Curl
curl --location --globoff 'https://api-sandbox.klavi.ai/data/v1/consents/{consentId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://api-sandbox.klavi.ai/data/v1/consents/{consentId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
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"
}
{
    "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"
}
﻿
Response
Name
Type
Required
Description
consentId
String
Yes
Consent identify
linkId
String
Yes
Unique Link
externalTrackId
String
Yes
Partners to transfer tracking information
personalTaxId
String
Yes
The CPF of the end-user, for Personal Accounts only
businessTaxId
String
Yes
The CNPJ of the company, for Business Accounts only
institutionCode
String
Yes
Institution code, it returned by the /institutions
status
String
Yes
STARTED - Link created;
AWAITING_AUTHORISATION - Waiting for end-user consent authorization;
AWAITING_LGPD_AUTHORISATION - Waiting for end-user LGPD acceptance; (required for Financial Data)
AUTHORISED - Link authorized by the end-user (valid status to call data endpoints);
ERROR - There was an issue in the link authorization flow
REJECTED - End-user rejected the link authorization
EXPIRED - Link expired by timeout (inactive for 20 minutes)
REVOKED - Link revoked (can be revoked by the end-user or the application)
DELETED_BY_USER - End-user requested data deletion via management portal
permissionsApply
Array
Yes
The permission required by partners for end user
permissionsGranted
Array
Yes
The permissions granted by end users
expireAt
String
Yes
Consent expire time(UTC time)
createdAt
String
Yes
Create consent time(UTC time)
updatedAt
String
Yes
Update data time(UTC time)
﻿

Name	Type	Required	Description
consentId	String	Yes	Consent identify
linkId	String	Yes	Unique Link
externalTrackId	String	Yes	Partners to transfer tracking information
personalTaxId	String	Yes	The CPF of the end-user, for Personal Accounts only
businessTaxId	String	Yes	The CNPJ of the company, for Business Accounts only
institutionCode	String	Yes	Institution code, it returned by the /institutions
status	String	Yes	STARTED - Link created; AWAITING_AUTHORISATION - Waiting for end-user consent authorization; AWAITING_LGPD_AUTHORISATION - Waiting for end-user LGPD acceptance; (required for Financial Data) AUTHORISED - Link authorized by the end-user (valid status to call data endpoints); ERROR - There was an issue in the link authorization flow REJECTED - End-user rejected the link authorization EXPIRED - Link expired by timeout (inactive for 20 minutes) REVOKED - Link revoked (can be revoked by the end-user or the application) DELETED_BY_USER - End-user requested data deletion via management portal
permissionsApply	Array	Yes	The permission required by partners for end user
permissionsGranted	Array	Yes	The permissions granted by end users
expireAt	String	Yes	Consent expire time(UTC time)
createdAt	String	Yes	Create consent time(UTC time)
updatedAt	String	Yes	Update data time(UTC time)

Updated 29 Sep 2024

Did this page help you?

Create a Consent

Get Consent List