Content Comparison

...

...

...

...

...

...

...

...

📁 Table of Contents

...

ℹ️ Introduction

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

...

, including full API integration.

...

...

Swagger

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

...

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 1️⃣ Make sure you have a valid access token to access our APIs.

...

2️⃣ Create Identity Verification (IDV) by making a

...

Generate IDV url

...

{
  "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"
}

...

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}

...

• Sandbox: https://sandbox-idv.ondato.com/?id={id}

2. Track customer onboarding progress

...

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.

...

...

4️⃣ 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}.

...

5️⃣ Retrieve data about

...

To retrieve customer onboarding details you first need to make a GET request to IDV API - Identity Verification (IDV) by making a

{
  "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"
    }
  }
}

...

6️⃣ Retrieve KYC data by making a

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdUtc": "2022-09-29T14:35:12.907Z",
  "setup": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "identityVerificationId": "1dbb6d1d-0596-4247-9b37-879e44c53ddc",
  "status": "Awaiting",
  "statusReason": "MissingDocumentPhoto",
  "isCrossChecked": true,
  "document": {
    "fullName": "John Adam Jones",
    "firstName": "John",
    "middleName": "Adam",
    "lastName": "Jones",
    "documentNumber": "PU2343443343",
    "dateOfIssue": "2000-02-03",
    "dateOfExpiration": "2000-02-03",
    "dateOfBirth": "2000-02-03",
    "personalCode": "199202030202",
    "address": "string",
    "nationalityIso3": "LTU",
    "countryIso3": "LTU",
    "countryStateIso2": "GR",
    "gender": "Male",
    "type": "IdCard",
    "mrzVerified": true,
    "category": "B",
    "files": [
      {
        "createdUtc": "2022-09-29T14:35:12.907Z",
        "fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "fileName": "identity_file.jpeg",
        "fileExtension": "jpeg",
        "part": "Front",
        "fileType": "DocumentPhoto"
      }
      ....

...

🔀 Integration sequence diagram

...