Face verification integration

Table of Contents

1 Introduction
2 Integration steps

Introduction

This documentation is designed to walk you through the integration of the face verification flow. The flow confirms the user's identity by matching their face to a provided image, with liveness assurance.

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

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.

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

{
  "id": "f5b3f02f-36c5-42ec-a2d5-fb96875ec216"
}

More information about setups can be found here: Getting started | ⚙️ Setups.

Obtain KYC setupId by making a get request to the IDV API → /v1/identity-verifications/{id}/setup endpoint with the id from the step response (in this example d2a23cc8-e865-4a27-9528-2e075ba0c814):

{
  "id": "e1d81bcc-dcd5-446d-9a8f-1d03fac2a157",
  "versionId": "52cf6623-7d46-4c19-bd53-f7f9241d9315",
  "applicationId": "9faef8ff-d12d-4037-8072-9ec8cda3c94f",
  "createdUtc": "2022-09-30T10:30:34.493Z",
  "modifiedUtc": "2022-09-30T10:30:34.493Z",
  "isDisabled": false,
  "name": "Jurgitos setup Test Account",
  "webAppSetting": {
    "baseUrl": "https://sandbox-idv.ondato.com/",
    "localisationSettings": [
      {
        "successRedirectUrl": "https://www.ondato.com",
        "pageTitle": "Idv Title"
      }
    ]
  },
  "omnichannel": {
    "enabled": false,
    "appStoreEnabled": false,
    "restrictToSameIpAddress": false,
    "onlyMobileEnabled": false
  },
  "sessionScreenRecording": {
    "enabled": false
  },
  "steps": [
    {
      "type": "KycIdentification",
      "order": 1,
      "setupId": "d2a23cc8-e865-4a27-9528-2e075ba0c814"
    },
    {
      "type": "Consent",
      "order": 0
    }
  ]
}

Create KYC identification by making a post request to the KYC Identifications API → /v1/identifications endpoint.

Request should include the IDV ID obtained in step #2 and the KYC setup ID obtained in step #3. The response will provide the KYC ID.

{
  "identityVerificationId": "f5b3f02f-36c5-42ec-a2d5-fb96875ec216",
  "setupId": "d2a23cc8-e865-4a27-9528-2e075ba0c814"
}

{
  "id": "d400a315-6ccf-49f0-a09a-e47d082f8e53"
}

Submit face image by making a put request to the KYC Identifications API → /v1/identifications/{id}/face-tec-liveness-2d endpoint providing KYC id generated in step 4 as id request parameter.

{
  "auditImagesBase64": [
    "string"
  ],
  "isEtalon": true
}

Generate IDV process 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}

Production URL example: https://idv.ondato.com/?id=02c99769-51a5-4174-aa5b-3fa0c2e6bfef
This URL can be shared with your customers so that they can complete KYC identification.

If a white-labeled address is being used for the process, then idv.ondato.com should be replaced with the configured address, such as: https://subdomain.yourdomain.com/?id={id}.