For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
HomeAPI Reference
HomeAPI Reference
  • Overview
    • API Overview
  • Vlens API
      • POSTExtract national ID front
      • POSTExtract national ID back
      • POSTExtract passport data
      • POSTExtract car license front (owner info)
      • POSTExtract car license back (vehicle specs)
      • POSTExtract driving license data
      • POSTMatch face against ID photo
      • POSTCompare two face images
      • POSTLiveness detection (three frames)
      • POSTExtract license plate text
      • POSTClassify document type
      • POSTAML validation
Dashboard
LogoLogo
Vlens APIOCR

Liveness detection (three frames)

||View as Markdown|
POST
https://api.vlenseg.com/v1/ocr/liveness/multi
POST
/v1/ocr/liveness/multi
$curl -X POST https://api.vlenseg.com/v1/ocr/liveness/multi \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "image": "iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAIAAADTED8xAA==",
>  "face_1": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAA==",
>  "face_2": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hBB==",
>  "face_3": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hCC=="
>}'
200Successful
1{
2  "services": {
3    "validations": {
4      "validation_errors": [
5        {
6          "field": "dateOfBirth",
7          "value": "2005-02-30",
8          "errors": [
9            {
10              "code": 1001,
11              "message": "Invalid date of birth format or non-existent date."
12            }
13          ]
14        }
15      ]
16    },
17    "spoofing": {
18      "fake": false
19    },
20    "classification": {
21      "doc_type": "national_id"
22    },
23    "liveness": true,
24    "AML": {
25      "AML_matched": false,
26      "data": []
27    },
28    "SRC": {
29      "isValid": true,
30      "errorCode": 0,
31      "errorKey": "",
32      "errorMessage": ""
33    }
34  },
35  "data": {
36    "isVerificationProcessCompleted": true,
37    "isDigitalIdentityVerified": true,
38    "deviceInfo": "iPhone 13 Pro, iOS 16.4",
39    "user": {
40      "id": 123456789,
41      "name": "Ahmed",
42      "surname": "El-Sayed",
43      "fullName": "Ahmed Mohamed El-Sayed",
44      "userName": "ahmed.el.sayed",
45      "emailAddress": "ahmed.elsayed@example.com",
46      "phoneNumber": "+201234567890",
47      "idNumber": "29805123456789",
48      "address": "123 Nile Street, Cairo, Egypt"
49    },
50    "idFrontData": {
51      "first_name": "أحمد",
52      "last_names": "محمد السيد",
53      "name": "أحمد محمد السيد",
54      "first_name_english": "Ahmed",
55      "last_names_english": "Mohamed El-Sayed",
56      "name_english": "Ahmed Mohamed El-Sayed",
57      "address": "١٢٣ شارع النيل، القاهرة، مصر",
58      "address_1": "123 Nile Street",
59      "address_2": "Downtown",
60      "address_english": "123 Nile Street, Downtown",
61      "govern": "القاهرة",
62      "govern_english": "Cairo",
63      "city": "Cairo",
64      "district": "Downtown",
65      "idNumber": "29805123456789",
66      "idKey": "A1B2C3D4",
67      "dateOfBirth": "1998-05-15T00:00:00Z",
68      "gender": "ذكر",
69      "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
70      "request_id": "660e8400-e29b-41d4-a716-446655440111",
71      "client_transaction_id": "770e8400-e29b-41d4-a716-446655440222"
72    },
73    "idBackData": {
74      "maritalStatus": "متزوج",
75      "marital_status_english": "Married",
76      "job": "مهندس برمجيات",
77      "job_english": "Software Engineer",
78      "jobTitle": "Senior Developer",
79      "job_title_english": "Senior Developer",
80      "religion": "مسلم",
81      "religion_english": "Muslim",
82      "husbandName": "",
83      "husbandName_english": "",
84      "releaseDate": "2018-06-01T00:00:00Z",
85      "idExpiry": "2028-06-01T00:00:00Z",
86      "idNumber": "29805123456789",
87      "gender": "ذكر",
88      "gender_english": "Male",
89      "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
90      "request_id": "660e8400-e29b-41d4-a716-446655440111",
91      "client_transaction_id": "770e8400-e29b-41d4-a716-446655440222"
92    }
93  },
94  "error_code": 0,
95  "error_message": "",
96  "error_descriptions": null
97}

Verify that a set of face images is from a live person using three frames captured within 0.5 seconds of each other. Requires an existing transaction_id with an ID front.

Was this page helpful?
Previous

Compare two face images

Next

Extract license plate text

Built with

Authentication

ApiKeystring
Static API key issued to your tenant. Obtain from the Vlens dashboard.
AuthorizationBearer
Short-lived JWT. Obtain via: - `/api/credentials/Login` for admin / service tokens - `/api/DigitalIdentity/Register` or login for end-user tokens

Request

This endpoint expects an object.
imagestringRequired

Base64-encoded ID front image.

face_1stringRequired

Base64-encoded face image, capture 1.

face_2stringRequired

Base64-encoded face image, capture 2.

face_3stringRequired

Base64-encoded face image, capture 3.

id_front_imagestring or nullOptional
name_check_valuestring or nullOptional
transaction_idstring or nullOptionalformat: "uuid"

Transaction ID from the ID front/back steps. Link liveness to the same transaction.

client_transaction_idstring or nullOptional
request_idstring or nullOptional
countrystring or nullOptional
getExtractedDatabooleanOptionalDefaults to false

Response

Liveness result.
servicesobject
Results from the various backend verification services.
dataobject
Combined result of the Digital Identity verification process.
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null

Short-lived JWT. Obtain via:

  • /api/credentials/Login for admin / service tokens
  • /api/DigitalIdentity/Register or login for end-user tokens