Basic WhiteLabel
The Basic WhiteLabel is the easiest way to use Klavi services when you lack technical development resources. You just need to contact the business personnel(crie@klavi.ai) to request a pre generated URL from Klavi for you. You can integrate this URL into your service and directly send it to your users.
The generated URL is similar to this:
If you were a klavi customer before 22/11/2024, you may be able to use the links according to the old nomenclature, then, it should be similar to this: https://open-sandbox.klavi.ai/data/v1/basic-links/yourappid
According to your business needs, if you want to lock end users or prevent users from entering CPF again, you can add personal_tax_id to the above URL, similar to this:
If you were a klavi customer before 22/11/2024, you may be able to use the links according to the old nomenclature, then, it should be similar to this: https://open-sandbox.klavi.ai/data/v1/basic-links/yourappid?personal_tax_id=76109277673
As mentioned above, the path parameter supports the following parameters:
Parameter name | Type | Description |
|---|---|---|
personal_tax_id | String | The CPF of the end-user, for Personal Accounts only |
business_tax_id | String | The CNPJ of the company, for Business Accounts only |
String | End user's email, compliance needs | |
phone | String | End user's phone, compliance needs |
institution_code | String | Pre set parameters, the purpose is to avoid users choosing specific institutions |
redirect_url | String | The URL for redirection upon successful link initialization. It's value must be processed in encodeURIComponent() function as below, for example: “%3a” replaces “:” “%2f” replaces “/” “%3f” replaces “?” “%3d” replaces “=” |
products_callback_url | String | Report products callback URL, for Open finance only. It's value must be processed in encodeURIComponent() function as below, for example: “%3a” replaces “:” “%2f” replaces “/” “%3f” replaces “?” “%3d” replaces “=” |
external_info | String | Used for partners to transmit information, which will be carried in reports sent to partners. It's value must be processed in encodeURIComponent() function as below, for example: “%3a” replaces “:” “%2f” replaces “/” “%3f” replaces “?” “%3d” replaces “=” |
connection_key | String | Connection key, the connectionKey has been sent to the partner in the report, for Open data update case only |
app_link | String | After the organization authorization is completed, it will jump to the URL address of app_link. The URL carries the parameter key, which is the value of app_redirect_url_key, and value is the URL address to be redirect. |
app_redirect_url_key | String | Need to be used together with app_link to identify the URL parameter key that the App needs to redirect. |
Perhaps you have noticed that the above parameters similar to the Create a Link API parameters except for changing from a camelCase to snake_case. That's right, it's like this because these parameters are in the body of the API when Create a Link, so camelCase is used. However, if you want to use path parameters to pass, it's best to use a snake_case.
Another very important point:
1.redirect_url to being a URL, If you want to use this parameters, remember to encode them.
2.products_callback_url and external_info is object type in Create a Link API, If you want to use these parameters, remember to stringify and encode them.
There is an exception, the object with key customization can be used by partners to customize some content of whitelabel.
For specific customized content, please contact the operations personnel(crie@klavi.ai).
You can use web or webview to open the Link URL, make subsequent selection of institutions, redirect to that institution for authentication, and return to the final result web page.
Klavi backend will send you the results through event webhook(even if it is a failed state), after the status change to AUTHORISED, you can send the specific report generation request you want based on the end user type(personal or business, their endpoints are different).
Command:
Expected response:
After you submit a request to generate specific or all report(The report you want to purchase has already been limited by Klavi backend), Klavi randomly starts retrieving data from the institution and processing it to generate the corresponding report, which will be sent to you through the report webhook.
Klavi also supports not having to actively call this endpoint. After you move to production, Klavi can proactively send all the reports to your webhook, or send them to Klavi's storage space. You can download them at any time through the Klavi Console.
