consents

Bearer access token, it returned by the /auth

Authorization

consentId

linkId

Partners to transfer tracking information

externalTrackId

The CPF of the end-user, for Personal Accounts only

personalTaxId

The CNPJ of the company, for Business Accounts only

businessTaxId

Institution code, it returned by the /institutions

institutionCode

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

status

The permission required by partners for end-user

permissionsApply

permissionsGranted

expireAt

createdAt

updatedAt

Create a Consent

Get a Consent

Get Consent List

Klavi Conecte Docs

OVERVIEW

Overview

Concepts

Basic WhiteLabel

Advance WhiteLabel

API Only

How to integrate Link

API Call Sequence Diagram

Integration WhiteLabel using App2App Flow

React Native integration

Flutter integration

Integration with WhiteLabel

WhiteLabel User Journey

Web Tracking Events

Event And Page Location

WhiteLabel Web Tracking

Postman Collection

Participant Institutions

Consent Permissions

Environment

Security

Rate Limits and Throughput

Date and Time formatting

Institution credentials format

MFA Format

Open Data Input Format

Open Finance Codes and Errors

Open Data Codes and Errors

Codes and Errors

Quick Start Guide

API Events

Event Webhooks

Product Webhooks

Webhooks

Common Format

Sensitive Information

checking_account

savings_account

credit_card

balance

loans

financing

unarranged_account_overdraft

invoice_financing

variable_incomes

bank_fixed_incomes

treasure_titles

funds

credit_fixed_incomes

categorized_checking_l2

categorized_savings_l2

categorized_creditcard_l2

categorized_checking_l3

categorized_savings_l3

categorized_creditcard_l3

Basic data

financial_entries

credit_risk

income

recurrent expenses

Competing Debit

Bets indicator

Credit score l1

Credit score l2

Credit score l3

Credit score l5

Credit score c1

Processed data

financial_products

non_financial_products

principality

Advanced data

identity

Products

Generate Access Token

Refresh Access Token

Authentication

Create a Link

Link management

Get Institution List

Select Institution

Get Status Of Selected Institution

Participants

Revoke a Consent

Consents

Personal

Business

Open data

Obtain product data

API REFERENCE

Release History