Skip to navigation
Vlens APIOCRGeneral document processing

Scan Egyptian Tax ID card

View as Markdown

Extracts company name, legal form, tax number, activity and activity code, address, dates, and factory ID from an Egyptian Tax ID card image. For file upload instead of base64, use POST /v1/ocr/tax_id_card/file.

Requires the Tax ID OCR service address to be configured in server settings (and the service restarted) before this endpoint is available.

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.

datamap from strings to anyOptional

Document-specific extracted fields.

error_codeinteger or nullOptional
error_messagestring or nullOptional