Get Consent List

1 min

{ "name" "consents", "method" "get", "url" "https //api sandbox klavi ai/data/v1/consents", "description" "get consent list by end user's cpf or cnpj ", "tab" "examples", "examples" { "languages" \[ { "id" "fwjpuqzmvbbmzermm 03s", "language" "curl", "code" "curl location 'https //api sandbox klavi ai/data/v1/consents' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json'", "customlabel" "" } ], "selectedlanguageid" "fwjpuqzmvbbmzermm 03s" }, "results" { "languages" \[ { "id" "vzickocsfsvuk5swwbh4m", "language" "200", "customlabel" "", "code" "\[\n {\n \\"consentid\\" \\"ac246093 353b 4310 bd9c c6ce0b278de8\\",\n \\"linkid\\" \\"85a3af9f e8ab 4be8 86dd 6138e9f2474c\\",\n \\"externaltrackid\\" \\"113ee41e 1ecf 41b7 b6a9 c24d7f84bdfd\\",\n \\"personaltaxid\\" \\"16109277673\\",\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 },\n {\n \\"consentid\\" \\"4942ef1e 18c2 4421 8bc9 ae0348d3b1bf\\",\n \\"linkid\\" \\"9cec914d 7663 4f4e aa90 39efe8f0f279\\",\n \\"externaltrackid\\" \\"f47d4959 3a9d 4856 83e8 7b653f2f383a\\",\n \\"personaltaxid\\" \\"16109277673\\",\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 }\n]" } ], "selectedlanguageid" "vzickocsfsvuk5swwbh4m" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "personaltaxid", "kind" "optional", "type" "string", "description" "the cpf of the end user, for personal accounts only(if end user is personal required)", "children" \[] }, { "name" "businesstaxid", "kind" "optional", "type" "string", "description" "the cnpj of the company, for business accounts only(if end user is business required)", "children" \[] }, { "name" "linkid", "kind" "optional", "type" "string", "description" "link identify, it returned by the /links", "children" \[] } ], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer access token, it returned by the /auth", "children" \[] } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "response" \[ { "name" "consentid", "kind" "optional", "type" "string", "description" "consent identify" }, { "name" "linkid", "kind" "optional", "type" "string", "description" "link identify", "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 link created;\nawaiting authorisation waiting for end user consent authorization;\nawaiting lgpd authorisation waiting for end user lgpd acceptance; (required for financial data)\nauthorised link authorized by the end user (valid status to call data endpoints);\nerror there was an issue in the link authorization flow\nrejected end user rejected the link authorization\nexpired link expired by timeout (inactive for 20 minutes)\nrevoked link 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" "array", "description" "the permission required by partners for end user", "children" \[] }, { "name" "permissionsgranted", "kind" "optional", "type" "array", "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" \[] } ] }