Customer onboarding (KYC) integration with UI

Table of Contents

1 Introduction
2 Integration workflow
3 Integration steps
4 Integration sequence diagram

Introduction

This documentation is designed to walk you through the Customer Onboarding (KYC) process, including full API integration.

Extent of the integration can be adjusted based on your business individual needs.
Please contact [support@ondato.com] for more details.

Please be advised that the use of iFrame is not supported.

Integration workflow

Integration steps

Make sure you have a valid access token to access our APIs.

For more information on how to obtain one, please visit Authentication.

Create Identity Verification (IDV) by making a post request to the IDV API → /v1/identity-verifications endpoint with setupId in the request body.

{
  "externalReferenceId": "123",
  "registration": {
    "dateOfBirth": "2021-01-14",
    "email": "John@email.com",
    "firstName": "John",
    "lastName": "Johnson",
    "middleName": "Adam",
    "personalCode": "1214148111000",
    "phoneNumber": 370624515141,
    "countryCode": "LT"
  },
  "setupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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}
Sandbox: https://sandbox-idv.ondato.com/?id={id}

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/{id}.

Retrieve data about Identity Verification (IDV) by making a get request to the IDV API → /v1/identity-verifications/{id} endpoint.

{
  "id": "89e50d98-c556-4818-8562-3cd98608bf09",
  "status": "Completed",
  "applicationId": "0736cd0c-5a8d-45f8-a000-b5205ff4922d",
  "createdUtc": "2022-09-29T14:17:19.171Z",
  "modifiedUtc": "2022-09-29T14:19:42.973Z",
  "setup": {
    "id": "0f60f6f8-8e73-4873-b2ee-e02275994a77",
    "versionId": "67613d97-37c9-4230-ad87-e2227cdb4f78"
  },
  "step": {
    "kycIdentification": {
      "id": "9ac12241-4333-46b0-8aa6-0b49e5444539"
    },
    "consent": {
      "isConsented": true,
      "consentedUtc": "2022-09-29T14:18:11.684Z"
    }
  }
}

Retrieve KYC data by making a get request to the KYC Identifications API → /v1/identifications/{id} endpoint to retrieve KYC Identifications (KYC ID) details.

Ondato

Customer onboarding (KYC) integration with UI

Analytics

Introduction

Integration workflow

Integration steps

Integration sequence diagram

Related content