Webview
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 |
callback_url (required) | The redirecting URL after bank connection. It can be a webpage or native app page. | To include a callback_url inside the full URL, the callback_url value must be processed in `encodeURIcompenent()` function as below: - “%3a” replaces “:” - “%2f” replaces “/” - “%3f” replaces “?” - “%3d” replaces “=” |
cancel_url (required) | The redirecting URL when users cancel the bank connection. It can be a webpage or native app page | To include a cancel_url inside the full URL, the callback_url value must be processed in encodeURIcompenent() function as below:: - “%3a” replaces “:” - “%2f” replaces “/” - “%3f” replaces “?” - “%3d” replaces “=” |
Example of Link URL redirecting to a webpage:
The correspondent callback_url after decoding:
https://partnerDomain.com?partnerParameter=value
The complete link to embed Klavi Link through webview is as follows:
https://open-testing.klavi.ai/partner_code?cpf=12345678910&callback_url=https%3a%2f%2fpartnerDomain.com%3fpartnerParameter%3dvalue
Example of Link URL redirecting to a native APP page:
The correspondent callback_url after decoding:
partnerAppSchemeDemo://partnerAppPage?partnerParameter=value
The complete link to embed Klavi Link through native APP is as follows:
https://open-testing.klavi.ai/partner_code?cpf=12345678910&callback_url=partnerAppSchemeDemo%3a%2f%2fpartnerAppPage%3fpartnerParameter%3dvalue