Vlens APIOCR

Match face against ID photo

View as Markdown

Compare a face image against the ID front photo stored in an existing transaction. Returns a match result, dissimilarity score, and detection flags.

Requires id/front to have been called on the same transaction_id first — the ID front image is fetched automatically.

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 JPEG/PNG image of the document side.

name_check_valuestring or nullOptional

Optional name to cross-validate against OCR-extracted data.

transaction_idstring or nullOptionalformat: "uuid"

Continue an existing transaction. Omit to start a new transaction; the ID is returned in the response.

client_transaction_idstring or nullOptional
Your own reference ID for this verification transaction.
request_idstring or nullOptional
countrystring or nullOptional

ISO 3166-1 alpha-2 country code. Defaults to EG.

getExtractedDatabooleanOptionalDefaults to false

Include OCR-extracted fields in the response.

Response

Face match result.
servicesobject
Results from the various backend verification services.
dataobject
Result of matching a face image against an ID photo.
error_codeinteger or null
error_messagestring or null