Vlens APIOCRFace

Liveness detection

View as Markdown

Verifies that a face is from a live person using three frames. All three images must be of the same person and captured within 0.5 seconds of each other. The result is returned in services.liveness.

Authentication

ApiKeystring
Static API key issued to your tenant. Required on every request.
OR
AuthorizationBearer

End-user JWT from registration or login. Required for verification, signing, and user-scoped operations.

Request

This endpoint expects an object.
face_1stringRequired

Base64-encoded frame 1. Compress to under 500 KB.

face_2stringRequired

Base64-encoded frame 2.

face_3stringRequired

Base64-encoded frame 3.

transaction_idstringOptional
Transaction to attach the liveness result to.

Response

servicesobjectOptional

Per-service check results attached to every OCR response.

datamap from strings to anyOptional

Document-specific extracted fields.

error_codeinteger or nullOptional
error_messagestring or nullOptional