Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

📁 Table of Contents

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

🐾 Integration steps

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

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

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

 Request example
{
  "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"
}
 Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

More information about setups can be found here: https://ondato.atlassian.net/wiki/spaces/PUB/pages/2295759776/Getting+started#%E2%9A%99%EF%B8%8F-Setups.

3️⃣ Pass on the Identity Verifications (IDV) id that was received in step #2.

The instructions for passing the necessary parameters to the SDK are available on the Ondato GitHub account.

4️⃣ Track customer onboarding progress by receiving webhooks.

To get more details about Ondato webhooks and how to begin receiving them, please check out the following page: Webhooks.

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

 Response example
{
  "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 GET request to the KYC Identifications API → /v1/identifications/{id} endpoint to retrieve KYC Identifications (KYC ID) details.

 Response example
{
  "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"
      }
      ....

To get the media files use fileId and call GET /v1/identifications/{id}/files/{fileId}.

  • No labels