Concepts
A Link represents your user's consent for data access and Open Finance authentication.
To use any of Klavi's data sharing products, you must first Create a Link.
A Link is the term for the relationship between your application and Klavi. Once your user has granted Klavi with a consent and undergone the authentication process with their institution, Klavi will have access to collect their data.
For Financial Data, Klavi will inquire the user for a data sharing Authorization, supported by the LGPD regulation, asking them a second consent to share their data from Klavi with your application. Once granted, your application will have permission to fetch the user's data using their id.
An authorized Link will give access to the different data scopes shared by the user (Account/Credit Card/Credit Operations), Klavi support a Link bound to multiple accounts of multiple banks or institutions.
Open Finance is built upon data access being shared by an end user who has given full and informed consent. The consent is given to and stored by Klavi, as the licensed Payment Initiation Service Provider (PISP/ITP).
Every consent has a limited length of validity, and will expire in due time. When a consent expires you won’t be able to access data until your user reconfirms their consent.
Consent Status | Description |
---|---|
STARTED | Link created, start to consent flow |
AWAITING_AUTHORISATION | Waiting for end-user consent 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 link authorization flow |
REJECTED | End-user rejected the link authorization |
EXPIRED | Consent expired |
REVOKED | Consent revoked by end-user or other application |
DELETED_BY_USER | End-user requested data deletion via management portal |