API REFERENCE
Consents
Get a Consent
1 min
{ "name" "consents", "method" "get", "url" "https //api sandbox klavi ai/data/v1/consents/{consentid}", "description" "get a consent by its consentid", "tab" "examples", "examples" { "languages" \[ { "id" "aio0lo6ztlwszniofoxiv", "language" "curl", "code" "curl location globoff 'https //api sandbox klavi ai/data/v1/consents/{consentid}' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" } ], "selectedlanguageid" "aio0lo6ztlwszniofoxiv" }, "results" { "languages" \[ { "id" "t1kdaw8zzzljjavchojqm", "language" "200", "customlabel" "", "code" "{\n \\"consentid\\" \\"ac246093 353b 4310 bd9c c6ce0b278de8\\",\n \\"linkid\\" \\"85a3af9f e8ab 4be8 86dd 6138e9f2474c\\",\n \\"externaltrackid\\" \\"113ee41e 1ecf 41b7 b6a9 c24d7f84bdfd\\",\n \\"personaltaxid\\" \\"16109277672\\",\n \\"businesstaxid\\" \\"\\",\n \\"institutioncode\\" \\"001\\",\n \\"status\\" \\"authorised\\",\n \\"permissionsapply\\" \n \[\n \\"accounts all\\",\n \\"credit cards all\\",\n \\"credit operations all\\",\n \\"registration all\\",\n \\"investments all\\"\n ],\n \\"permissionsgranted\\" \n \[\n \\"accounts all\\",\n \\"credit cards all\\",\n \\"credit operations all\\",\n \\"registration all\\",\n \\"investments all\\"\n ],\n \\"expireat\\" \\"2024 12 07t23 59 59 999z\\",\n \\"createdat\\" \\"2023 12 08t09 19 19 253z\\",\n \\"updatedat\\" \\"2023 12 08t11 29 50 253z\\"\n}" } ], "selectedlanguageid" "t1kdaw8zzzljjavchojqm" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer access token, it returned by the /auth", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "response" \[ { "name" "consentid", "kind" "optional", "type" "string", "description" "consent identify" }, { "name" "linkid", "kind" "optional", "type" "string", "description" "unique link", "children" \[] }, { "name" "externaltrackid", "kind" "optional", "type" "string", "description" "partners to transfer tracking information", "children" \[] }, { "name" "personaltaxid", "kind" "optional", "type" "string", "description" "the cpf of the end user, for personal accounts only", "children" \[] }, { "name" "businesstaxid", "kind" "optional", "type" "string", "description" "the cnpj of the company, for business accounts only", "children" \[] }, { "name" "institutioncode", "kind" "optional", "type" "string", "description" "institution code, it returned by the /institutions", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "started consent created;\nawaiting authorisation waiting for end user authorization;\nawaiting lgpd authorisation waiting for end user lgpd acceptance; (required for financial data)\nauthorised consent authorized by the end user (valid status to call data endpoints);\nerror there was an issue in the consent authorization flow\nrejected end user rejected the consent authorization\nexpired consent expired by timeout (inactive for 30 minutes)\nrevoked consent revoked (can be revoked by the end user or the application)\ndeleted by user end user requested data deletion", "children" \[] }, { "name" "permissionsapply", "kind" "optional", "type" "string", "description" "the permission required by partners for end user", "children" \[] }, { "name" "permissionsgranted", "kind" "optional", "type" "string", "description" "the permissions granted by end users", "children" \[] }, { "name" "expireat", "kind" "optional", "type" "string", "description" "consent expire time(utc time)", "children" \[] }, { "name" "createdat", "kind" "optional", "type" "string", "description" "create consent time(utc time)", "children" \[] }, { "name" "updatedat", "kind" "optional", "type" "string", "description" "update data time(utc time)", "children" \[] } ] }