Quick Start
4 min
Introduction
This Quick Start section will guide you through your first Conecte Sandbox integration steps, enabling consent creation and mocked product requests.
What all integration methods have in common
- Link session
- The session used to start the consent flow.
- Open Finance Consent
- Authorisation granted by the user to Klavi to access data from a financial institution.
- LGPD Consent
- LGPD authorisation granted by the user to Klavi to allow data sharing with its partners.
- Events (optional)
- Webhook notifications used to track the consent lifecycle.
- Asynchronous Data Delivery
- Data is processed and delivered asynchronously.
Integration Methods
Klavi offers 3 different integration methods3 different integration methods that vary in regards to development effort and integration robustness.
Don't know which method to choose?
- Basic Whitelabel
- Static whitelabel URL, fully hosted by Klavi.
- Best for quick integrations with minimal setup effort.
- Advanced Whitelabel
- Dynamic whitelabel URL, fully hosted by Klavi.
- Recommended when you need more security and session management, has medium setup effort.
- API Only
- Back-end based integration, fully hosted by the partner.
- Ideal for advanced use cases that require full control over the user experience.
What you need before starting
Before integrating, make sure you have:
- Access to a Klavi Console account used for configurations
- A Sandbox app and its corresponding credentials or static URL
- Configured an events receival address in Klavi Console
- Configured a products receival address in Klavi Console
Your first consent and product request
- Obtain the AccessKey and SecretKey from your app through Klavi Console
- Request the /linksa endpoint to obtain the linkToken
- Request the /institutionsi endpoint to collect available institutions data
- Request the /consentsa endpoint to create the consentRedirectUrl
- Open the consentRedirectUrl and complete the authorisation process
- Verify if your application successfuly received and parsed the API EventsAPI Events
- Use the data from the consent_authorised event to request institution-levelinstitution-level or user-levelu products
- Verifiy if your application successfuly received and parsed the requested products