Connection update

9 min

Klavi supports the partner to continuously check the update of the user account. Based on different scenarios, the partner can choose one of the methods below to perform the connection update.

Such methods are valid only after the first connection when the unique user identifier "connection_key" was generated.

Method	Scenario	Description
API for auto update(No user participation required)	Applicable for the banks who don’t require multi-factor authentication (MFA) for login	POST to the API and request for account update, given the auto update feature is enabled
Link for connection update(User participation required)	Applicable for the banks who require multi-factor authentication (MFA) for login, or in case the user has changed the password	Request to the Link URL for connection update ("connection_key" is required for user identification)

Auto update sync

Tips:

This autoupdate_sync API will depend on previous user credentials. However, there is always a chance that users have changed their credentials when we tried to update.

So, as soon as you receive any of the error codes related to wrong credentials, such as 402, 406, and 408, please stop calling this API, instead, ask users to connect with new credentials again. Otherwise, the wrong credentials case would stick and might cause account-blocking issues.

/autoupdate_sync

To update your account, you need to call the following API through POST. The updated JSON reports will be sent to your original webhook.

POST

https://api-testing.klavi.ai/link/account/v1/autoupdate_sync

$ curl -X POST https://api-testing.klavi.ai/link/account/v1/autoupdate_sync \
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '{"connection_key":"ae8bdbac023f541ce9152fdba96389d7"}'

Auto update config

/autoupdate_config

For auto update configuration change, you need to call the following API through POST.

POST

https://api-testing.klavi.ai/link/account/v1/autoupdate_config

$ curl -X POST https://api-testing.klavi.ai/link/account/v1/autoupdate_config \
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '{
        "connection_key":"ae8bdbac023f541ce9152fdba96389d7",
        "allow_autoupdate":"Yes"
    }'

Link for connection update

This method is typically suitable for the banks who require multi-factor authentication (MFA) for login and it is valid only after the first connection. The bank selection and login credential input processes will be skipped to make the user experience better.

Paremeter	Purpose	Remark
connection_key(required)	Unique key for a specific bank connection of the certain user	It will be generated after the first connection and can be found in the JSON report of the first connection
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

https://open-testing.klavi.ai/{partner_code}/update?connection_key=xxxxxxxxxx&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

https://open-testing.klavi.ai/{partner_code}/update?connection_key=xxxxxxxxxx&callback_url=partnerAppSchemeDemo%3a%2f%2fpartnerAppPage%3fpartnerParameter%3dvalue

Link URLs in different environment: https://open-sandbox.klavi.ai/{partner_code}/update (Sandbox) https://open-testing.klavi.ai/{partner_code}/update (Development) https://open.klavi.ai/{partner_code}/update (Production)

Account deletion

/delete

To delete the user connection upon their request, you need to call the following API through POST. Please note such deletion is permanent and can’t be recovered.

POST

https://api-testing.klavi.ai/link/account/v1/delete

curl -X POST https://api-testing.klavi.ai/link/account/v1/delete
-H 'Content-Type: application/json' \
-H 'partner_code: 123xxx' \
-H 'partner_token: 2fd6cbcddeafd5ToRxbv8Q9UtfDMO' \
-d '{"connection_key":"ae8bdbac023f541ce9152fdba96389d7"}'