📁 Table of Contents
| Table of Contents | ||||
|---|---|---|---|---|
|
...
ℹ️ Introduction
This documentation will guide is designed to walk you through the Customer Onboarding (KYC) process with a full Ondato APIs , including full API integration.
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Extent of the integration can be adjusted based on your business individual needs. |
| Note |
|---|
Please be advised that the use of iFrame is not supported. |
...
🔶 Integration workflow
| Drawio | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
🐾 Integration steps
1️⃣ Make sure
...
you have a valid access token to access our APIs.
...
| Info |
|---|
For more information on how to obtain one |
...
, please visit Authentication. |
...
2️⃣ Create Identity Verification (IDV) by making
...
a
| Status | ||||
|---|---|---|---|---|
|
...
→ /v1/identity-verifications
...
endpoint with setupId in the request body.
...
| Expand | ||
|---|---|---|
|
...
|
| Expand | ||
|---|---|---|
|
...
|
| Info |
|---|
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️⃣ Generate IDV URL with
...
Identity Verifications (IDV) id that was received in step #2.
The URL must be in the following format:
Production: https://idv.ondato.com/?id={id}
Production URL example: https://idv.ondato.com/?id=02c99769-51a5-4174-aa5b-3fa0c2e6bfef
This URL can be shared with your customers so that they can complete KYC identification.
| Info |
|---|
If a white-labeled address is being used for the process, then idv.ondato.com should be replaced with the configured address, such as: https://subdomain.yourdomain.com/?id={id}. |
...
4️⃣ Track customer onboarding progress by receiving webhooks.
...
...
include payload information from the
...
KYC Identifications API resource
/v1/identifications/{id}.
...
IDV webhooks will
...
include payload information from the
...
...
resource
/v1/identity-verifications/{id}.
| Info |
|---|
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
...
| Status | ||||
|---|---|---|---|---|
|
...
→ /v1/identity-verifications/{id} endpoint.
| Expand | ||
|---|---|---|
|
...
|
...
6️⃣ Retrieve KYC data by making a
...
| Status | ||||
|---|---|---|---|---|
|
/v1/identifications/{id} endpoint to retrieve KYC ...
Identifications (KYC ID) details.
| Expand | ||
|---|---|---|
|
...
|
| Info | ||||||
|---|---|---|---|---|---|---|
To get the media files use
/v1/identifications/{id}/files/{fileId}. |
...
🔀 Integration sequence diagram
...