📁 Table of Contents
ℹ️ Introduction
This documentation will guide you through the Customer Onboarding (KYC) process with a full Ondato APIs integration.
The level of integration can be customized to suit your specific business requirements.
Please contact [support@ondato.com] for more details.
🐾 Integration steps
1️⃣ Make sure you have a valid access token to access our APIs.
For more information on how to obtain one, please visit Authentication.
2️⃣ Create Identity Verification (IDV) by making a POST request to the IDV API → /v1/identity-verifications
endpoint with setupId
in the request body.
More information about setups can be found here: https://ondato.atlassian.net/wiki/spaces/PUB/pages/2295759776/Getting+started#%E2%9A%99%EF%B8%8F-Setups.
3️⃣ Pass on the Identity Verifications (IDV) id
that was received in step #2.
The instructions for passing the necessary parameters to the SDK are available on the Ondato GitHub account.
4️⃣ Track customer onboarding progress by receiving webhooks.
KYC identification webhooks will include payload information from the KYC Identifications API resource
/v1/identifications/{id}
.IDV webhooks will include payload information from the IDV API resource
/v1/identity-verifications
.
To get more details about Ondato webhooks and how to begin receiving them, please check out the following page: Webhooks.
5️⃣ Retrieve data about Identity Verification (IDV) by making a GET request to the IDV API → /v1/identity-verifications/{id}
endpoint.
6️⃣ Retrieve KYC data by making a GET request to the KYC Identifications API → /v1/identifications/{id}
endpoint to retrieve KYC Identifications (KYC ID) details.
To get the media files use fileId
and call GET /v1/identifications/{id}/files/{fileId}
.
0 Comments