Customer onboarding (KYC) partial integration

Introduction

This documentation will guide you through the Customer Onboarding (KYC) process with a partial Ondato APIs integration.

Getting started

Please find details about authentication and setups in the following page: Getting started .

Swagger

You will need to use the following APIs for the integration:

• Ondato IDV API to initiate the customer onboarding flow.

• Ondato KYC ID API to retrieve data about KYC identifications.

Integration workflow

Integration steps

1. Initiate customer onboarding

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.

Generate IDV url

After you receive identity verification id, you can generate a url and redirect your user to it for filling in the customer 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

2. Track customer onboarding progress

Once customer onboarding process is initiated by you and customer starts the IDV flow - the rest of the process will be taken care of by Ondato. You can track the progress by receiving Ondato notifications about KYC identification.

KYC identification webhooks

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.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.

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.

Integration sequence diagram