Documentation
  • Introduction
  • Quick Start
  • Reference
    • API Reference
      • Documents OCR
      • Face Matching & Liveness
      • AML & blacklisting
      • Transliteration
      • Error Codes
      • OTP
Powered by GitBook
On this page
  • Face Matching
  • Matching between face captured and face on Identity documents
  • Liveness detection with multiple face images
  • Detecting Liveness
  1. Reference
  2. API Reference

Face Matching & Liveness

Sending face(s) to be analyzed for faces comparison and checking if the captured face(s) is/are live

Face Matching

Matching between face captured and face on Identity documents

POST https://api.vlenseg.com/v1/ocr​/face/match

Headers

Name
Type
Description

ApiKey*

string

API Key is the main authentication method for the request

Request Body

Name
Type
Description

transaction_id*

GUID

The transaction Id. Required as the comparison between face image must be with an existing Identity document within certain transaction.

image*

string

The base 64 encoding of the face image

 {
    "data": {
        "isMatched": <boolean>,
        "transaction_id": <string>,
        "client_transaction_id": <string>,
        "request_id": <string>
    },
    .
    .
    .
}

Liveness detection with multiple face images

Detecting Liveness

POST https://api.vlenseg.com/v1/ocr/liveness/multi

Detecting Liveness while matching between faces captured and face on Identity documents

Headers

Name
Type
Description

ApiKey*

string

API Key is the main authentication method for the request

Request Body

Name
Type
Description

transaction_id*

GUID

The transaction Id. Required as the comparison between faces image must be with an existing Identity document within certain transaction.

face_1*

string

The base 64 encoding of the 1st face image captured

face_2*

string

The base 64 encoding of the 2nd face image captured, the time gap between capturing it and 1st capture must not exceed 500 milliseconds

face_3*

string

The base 64 encoding of the 3rd face image captured, the time gap between capturing it and 2nd capture must not exceed 500 milliseconds

 {
    "data": {
        "isMatched": <boolean>,
        "Liveness": <boolean>,
        "transaction_id": <string>,
        "client_transaction_id": <string>,
        "request_id": <string>
    },
    .
    .
    .
}
  • Avoid attaching same image "Identical copy image" as this won't happen in real case and will result false liveness.

  • 3 face images must be for the same person as if not same person this will result false liveness.

  • 3 face images should simulate/be the real scenario, captured in sequence with time span of max 0.5 second between each. avoid sending 3 different captures for same person in totally different conditions like pose, background and lightning as this might result false liveness.

  • Compression is recommended so that images don't exceed 500 KB per each to avoid a long time in uploading images.

PreviousDocuments OCRNextAML & blacklisting

Last updated 1 year ago

2KB
Face Matching & Liveness.postman_collection.json