| Table of Contents | ||||
|---|---|---|---|---|
|
...
You will need to use the following APIs for the integration:
Ondato IDV APIto initiate the customer onboarding flow.
Ondato KYC ID API to retrieve data about KYC identifications.
...
To initiate business onboarding you need to make POST request to /v1/identity-verifications/ with setupId in the request body.
Response with status code 201 will return id of identity verification that can be used to generate IDV URL.
...
KycIdentification.Created- Webhook is triggered when new identification is started by the customer.Idv.Consented- Webhook is triggered when user accepts consent agreement on new identification.KycIdentification.Processed- Webhook is triggered when new identification is completed by the customer.KycIdentification.Approved- Webhook is triggered when identification is manually or automatically identified.KycIdentification.Updated- Webhook is triggered when document data is updated in Ondato Portal.KycIdentification.Rejected- Webhook is triggered when identification is manually or automatically unidentified.
KycIdentification webhooks will contain payload information from the Ondato Kyc Identification API recourse /v1/identity-verifications/{id}.
Idv webhooks will contain payload information from the Ondato IDV API recourse /v1/identity-verifications.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
To learn more about Ondato webhooks and how to configure webhook endpoints please see the following page: Webhooks. |
3. Retrieve data about completed KYC identification
To retrieve customer onboarding details you first need to make a GET request to IDV API - /v1/identity-verifications/{id} endpoint to receive KYC Identification ID. With this ID you need to make a GET request to Kyc Identification API - /v1/identifications/{id} endpoint to retrieve KYC identification details.
...