iFrame
Partners can integrate the Klavi Link page into their own applications through webview.
Partners can use the following preset parameters when calling the Klavi Link page. In addition, partners can customize any parameters that match the URL scheme based on their own business.
Parameter | Purpose | Remark |
|---|---|---|
uuid (required) | Unique user identifier in partner’s system | If provided, such data will be included in the JSON report for user matching in partner’s system. |
cpf (optional) | - User identification; - Required as bank connection credential | If not provided by partner, user would need to input it on the Link page. |
bank_id (optional) | The restricted bank for connection | If bank_id is included, user can only connect to the particular bank. The bank_id follows the central bank codes: - Banco do Brasil: 001 - Bradesco: 237 - Caixa: 104 - Itaú: 341 - Santander: 033 |
Event tracking
- Klavi supports event tracking of the Link pages, if required;
- The following is an example of event tracking messages for iFrame integration through windows.postMessage(). Such events and messages are customizable.
Event | Message |
|---|---|
Open institution list page | { code:200, msg:”OK”, page:”institution_login” } |
Click the user terms button | { code:200, msg:”OK”, page:’institution_terms’ } |
Click the privacy policy button | { code:200, msg:”OK”, page:”institution_policy” } |
Click the continue button after credential input | { code:200, msg:”OK”, page:”institution_loading” } |
The MFA page (popup) appears | { code:200, msg:”OK”, page:”institution_MFA” } |
Click the confirm button on MFA page (popup) | { code:200, msg:”OK”, page:”sync_starting” } |
Click the cancel button on MFA page (popup) | { code:402, msg:’User credential error’, page:’sync_canceled’ } |
🪄 Tip For more technical details of the Inline Frame element and windows.postMessage() , please refer to the following link: