Requirements

Overview

When creating a verification, you specify which checks the user must complete via the requirements array. The combination of requirements determines the verification workflow.

Requirement types

DOCUMENT_SCAN

User must scan an identity document (passport, national ID, driver license, voter card, refugee card, or residence permit).

FACE_SCAN

User must complete a biometric face scan with liveness detection.

Workflows

Full KYC onboarding
Returning user re-verification
Liveness check

Require both DOCUMENT_SCAN and FACE_SCAN. The system compares the user’s live face with their ID photo.

{
  "requirements": [
    { "type": "DOCUMENT_SCAN" },
    { "type": "FACE_SCAN" }
  ]
}

This is the most common workflow for new user onboarding. The identityDocument field on the verification response will contain all extracted document data once approved.

Require only FACE_SCAN with the previousVerificationId option. This matches a new face scan against a past, approved verification — without requiring the user to re-scan their document.

{
  "requirements": [
    {
      "type": "FACE_SCAN",
      "options": {
        "previousVerificationId": "aB1cD2eF"
      }
    }
  ]
}

The previousVerificationId option can only be used for face-only verifications. It cannot be combined with a DOCUMENT_SCAN requirement in the same session.

Require only FACE_SCAN without any options. This is a simple check to confirm the user is a real, live person, without document or identity comparison.

{
  "requirements": [
    { "type": "FACE_SCAN" }
  ]
}

Get Started

Guides

Overview

Requirement types

Workflows

Get Started

Guides

​Overview

​Requirement types

​Workflows

Overview

Requirement types

Workflows