Develop guides
Quickstart
How to get product
2min
Based on security and other considerations, Klavi currently does not provide GET APIs to partners. Instead, partners need to develop data receiving services based on the Json report format(Products) provided by Klavi. After Klavi completes the generation of the data report, it will automatically send the data product to the partner's data receiving service through webhook.
![Document image Document image](https://images.archbee.com/3aXvvCPme0Nq_nC3YOUoN/J_C3tFnVCXoxrYMyYVLpq_image.png?format=webp)
- For the user's first new connection, the partner can call klavi openbanking connection through iframe. The partner can add user-defined parameters such as UUID or sessionid, which will be sent to the partner together with the report, so that the partner can identify the ownership of the report. For details, please refer to How to integrate. For the user's second connection or data update, the partner can use the connection_key in the report to call autoupdate_ sync API. For details, pleasa refer to: Connection update.
- Klavi back-end save parameter data, starts collecting data, calculating and generating reports.
- 3.1 When the data collection task is created successfully, Klavi front-end notifies the partner through the windows.postMessage() of iframe, for details, pleasa refer to: iFrame.
3.2 Klavi back-end send reports to partner through webhook. 4. Partner can poll the back-end through UUID or sessionid and wait for the report to be received.
🪄 Tip IP whitelist is recommended to limit the access to your webhook for better security protection.
Updated 04 Dec 2023
Did this page help you?