| 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 KYC IDV URL.
Generate KYC IDV url
After you receive identity verification id, you can generate a url and redirect your user to it for filling in the business onboarding details. The url must be in the following format: "idv.ondato.com?id={id}”.
Example: http://idv.ondato.com/?id=02c99769-51a5-4174-aa5b-3fa0c2e6bfef
...
Ondato provides webhooks to alert you of changes in the status of customer identification. The following events will trigger a message to registered webhooks:
KycIdentification.StartedCreated- Webhook is triggered when new identification is started by the customer.KycIdentitificationIdv.ConsentAgreementAcceptedConsented- Webhook is triggered when user accepts consent agreement on new identification.KycIdentification.Processed- Webhook is triggered when new identification is completed by the customer.KycIDentificationKycIdentification.Corss_checkedApproved- Webhook is triggered when identification is cross checked / approved in Ondato Portalmanually or automatically identified.KycIdentification.Updated- Webhook is triggered when document data is updated in Ondato Portal.KycIdentification.Rejected- Webhook is triggered when identification is rejected in Ondato Portal.KycIdentification.Expired- Webhook is triggered when identification expires before it is started.
...
manually or automatically unidentified.
To learn more about Ondato webhooks and how to configure webhook endpoints please see the following page: Webhooks.
...
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.
...