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
      • POSTScan national ID front
      • POSTScan national ID back
      • POSTPerform liveness check
      • GETList user identity image references
      • GETDownload verification image (base64)
      • POSTLink user to existing OCR transaction
Dashboard
LogoLogo
Vlens APIDigital Identity

Perform liveness check

||View as Markdown|
POST
https://api.vlenseg.com/api/DigitalIdentity/verify/liveness/multi
POST
/api/DigitalIdentity/verify/liveness/multi
$curl -X POST https://api.vlenseg.com/api/DigitalIdentity/verify/liveness/multi \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "image": "/9j/4AAQSkZJRgAB...",
>  "face_1": "/9j/4AAQSkZJRgAB...",
>  "face_2": "/9j/4AAQSkZJRgAB...",
>  "face_3": "/9j/4AAQSkZJRgAB...",
>  "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>  "getExtractedData": true
>}'
200Digital Identity_verifyLivenessMulti_example
1{
2  "services": {
3    "spoofing": {
4      "fake": false
5    },
6    "liveness": true,
7    "AML": {
8      "AML_matched": false
9    },
10    "SRC": {
11      "isValid": true
12    }
13  },
14  "data": {
15    "isVerificationProcessCompleted": true,
16    "isDigitalIdentityVerified": true
17  },
18  "error_code": null
19}
Perform passive liveness detection using three face images. This is the final step of the Digital Identity verification flow. **Image requirements:** - All three images must be of the **same person** - Capture within **0.5 seconds** of each other to simulate natural movement - Compress each image to **under 500 KB** for optimal performance - Never submit identical images — the system will detect and reject them After this step, `data.isDigitalIdentityVerified` reflects whether the full verification passed, including any NTRA and CSO authority checks configured for your tenant.
Was this page helpful?
Previous

Scan national ID back

Next

List user identity image references

Built with

Perform passive liveness detection using three face images. This is the final step of the Digital Identity verification flow.

Image requirements:

  • All three images must be of the same person
  • Capture within 0.5 seconds of each other to simulate natural movement
  • Compress each image to under 500 KB for optimal performance
  • Never submit identical images — the system will detect and reject them

After this step, data.isDigitalIdentityVerified reflects whether the full verification passed, including any NTRA and CSO authority checks configured for your tenant.

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 check complete.
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