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 link is initialized (basic whitelabel) after /links docid\ mz5jywmwvljrezzqpd30s endpoint request (advanced whitelabel and api only) after cpf/cnpj confirmation (basic/advanced whitelabel) after /consents docid\ j28oksmduuoonqt53xsh7 endpoint request (api only) 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 docid\ l2p6pw11adwvumkns6pkc event and will have permission to fetch the user's data using the institution level docid 4riniovi1i501nopbxprc and user level docid\ vdaekvpwkhkhedbsro4ac apis