Create a Link
If you were a klavi customer before 22/11/2024, you may be able to use the links according to the old nomenclature, then, the linkURL response may look like: https://open-sandbox.klavi.ai/path?v=AhbGciOiJFUzI1NiIs.CtYjAyOC1hN2ZhMWFjZGRjZjkiLCJ0.UlTqpAZHeq4P2xFD
The end-user completes authorization and returns to the client's page URL from the LGDP page.
- If authorization succeeds, the Klavi backend returns the redirectURL with the link_id and external_info parameters
- If authorization fails, the Klavi backend returns the redirectURL with the link_id, external_info , error and error_description parameters
With this parameter, you can submit specific or all reports generated sending addresses to Klavi backend.
1.Specific reports example
After the report is generated, the Klavi backend will send the report pf_checking_account to https://www.yourdomain.com/checking/yourendpoint and send the report pf_credit_card to https://www.yourdomain.com/creditcard/yourpath.
2.Specific and other reports example
In this case, the Klavi backend will send the report pf_checking_account to https://www.yourdomain.com/checking/yourendpoint and send the other report to https://www.yourdomain.com/yourpath.
3.All reports example
After the report is generated, the Klavi backend will send all reports(You selected it when you onborading) to https://www.yourdomain.com/yourpath.
Please note that:
The parameter all is mutually exclusive with the parameters other and specific and cannot exist simultaneously. If it exists, the system will return an error.
You can submit any content you want with this parameter, and Klavi will temporarily save it. After the report is generated, it will be returned to you in the externalInfo data node of the report.
For example:
Name | Type | Required | Description |
---|---|---|---|
linkId | String | Yes | Unique identifier for the created link |
linkToken | String | Yes | The token of the created link You can think that the backend system will use accessToken(generated by /auth), while the front-end system will use this linkToken. Only API GET /institutions and POST /consents will use this linkToken for authentication |
linkURL | String | Yes | The Whitelabel application URL generated by Klavi for the partner, it can be opened as long as the partner's front-end requests this URL |
expireIn | String | Yes | The expiration time of the linkToken, the default expiration duration is 30 minutes. |