Concepts
Partner Configuration
Partner Account
Once the onboarding process starts, Klavi creates your partner account, which represents your organization and serves as the top-level entity in Klavi’s system.
Partner Applications
A partner account can contain one or more applications, which are used for integration and configuration.
Each application has its own set of configurations:
- Access Key & Secret Key
- Whitelabel user journey customization
- Transmitting institutions available for authorisation
- Reports enabled for request
- Reports and Events delivery addresses
- Delivery method (Autopost vs Fetch)
There are no limits to application creation. Partners may request as many applications as needed.
Each application can be independently configured according to where it will be used in the partner’s user journey.
For example, a partner whose business is credit provision may configure one application with the pf_identity report and whitelabel messaging focused on “accelerating the registration process”, to be used at the top of the onboarding funnel.
Alternatively, a second application may be configured with the pf_credit_risk report and whitelabel messaging focused on “credit reconsideration”, to be presented to users who were rejected during the initial analysis.
Link & Consent
Links and consents are closely related but represent different concepts in Klavi’s integration.
A link represents the session in which the end user interacts with the consent authorisation flow, while a consent represents the authorization granted by the user.
Link
Since Open Finance is based on end-user authorization for data access, all Klavi Conecte data-sharing products rely on the creation of a link session. A link is the session through which the end user interacts with the flow and may authorize one or more consents.
- Session-level object
- Represented by linkId
- Created using application credentials
- Loads application configuration
- Determines the end-user journey
- Can result in one or more consents
Consent
A consent is the authorization an end user grants to Klavi to access their data from a financial institution. After the user completes the required authorization steps, the consent becomes active and Klavi can collect data within its defined scope and share it with the partner.
There are 2 options regarding consent validity:
- Undetermined: valid until the user revokes it
- 12 months: valid for 12 months counting from authorisation date.
When a consent expires or is revoked, data can no longer be requested. To resume data access, the user must authorise a new consent.
- Regulatory authorization object
- Represented by consentId
- Created during a link session
- Used to track authorization status
- Is unique
Consent vs Link
Aspect | Link | Consent |
|---|---|---|
Purpose | Manage user session | Represent user authorisation |
Scope | Session-level | Authorisation-level |
Identifier | linkId | consentId |
Created when |
|
|
Relationship | One linkId -> one or more consentIds | Each consentId is unique |
Used for | Consent journey and configuration | Data access and status tracking |
Consent Status
The details regarding each of the possible consent status are listed in the table below:
Consent Status | Description |
|---|---|
STARTED | Link created, start to consent flow |
AWAITING_AUTHORISATION | Waiting for end-user Open Finance consent authorization |
AWAITING_LGPD_AUTHORISATION | Waiting for end-user LGPD authorisation; (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 | The link session expired before authorisation or rejection |
REVOKED | Consent revoked by end-user or other application |
DELETED_BY_USER | End-user requested data deletion |
Authorisation Types (Open Finance vs LGPD)
Klavi's data sharing authorisation flow is composed of 2 different authorisations:
- Open Finance Authorisation
This is the standard Open Finance authorisation journey where the end-user authorises the creation of a consent, through which a recipient institution (Klavi) is granted access to the end-user's data stored in a transmitting institution account.
- LGPD Data Sharing Authorisation
Once Open Finance authorisation is successful, Klavi will display the LGPD Data Sharing Authorisation step to the end-user.
The purpose of this authorisation is the end-user allowing Klavi to share the data with it's partners. Once granted, your application will receive the consent_authorised event and will have permission to fetch the user's data using the institution-levelinstitution-level and user-levela APIs.