Scan driving license

View as Markdown
Extracts holder and licence details from an Egyptian driving license.

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.
imagestringRequired

Base64-encoded JPEG or PNG. Max 3 MB.

transaction_idstringOptional
Group multiple steps into one transaction. Omit to start a new one.
client_transaction_idstringOptional
Your own reference ID.
countrystringOptionalDefaults to EGY

ISO country code. Defaults to EGY.

getExtractedDatabooleanOptionalDefaults to false
Include the full extracted fields in the response.

Response

servicesobjectOptional

Per-service check results attached to every OCR response.

dataobjectOptional
error_codeinteger or nullOptional
error_messagestring or nullOptional