Scan national ID — front

POST

/v1/ocr/id/front

POST

/v1/ocr/id/front

curl -X POST https://api.vlenseg.com/v1/ocr/id/front \
     -H "ApiKey: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "image": "<base64>",
  "getExtractedData": true
}'

200Successful

{
  "services": {
    "validations": {
      "validation_errors": [
        {
          "field": "string",
          "value": "string",
          "errors": [
            {
              "code": 1,
              "message": "string"
            }
          ]
        }
      ]
    },
    "spoofing": {
      "fake": true
    },
    "classification": {
      "doc_type": "string"
    },
    "liveness": true,
    "AML": {},
    "SRC": {}
  },
  "data": {
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "nameEnglish": "string",
    "firstNameEnglish": "string",
    "lastNamesEnglish": "string",
    "idNumber": "string",
    "idKey": "string",
    "dateOfBirth": "string",
    "gender": "string",
    "govern": "string",
    "governEnglish": "string",
    "address": "string",
    "addressEnglish": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "district": "string",
    "transaction_id": "string",
    "request_id": "string",
    "client_transaction_id": "string"
  },
  "error_code": 1,
  "error_message": "string"
}

Extracts the holder’s name, ID number, date of birth, gender and address from the front of an Egyptian national ID. Save the returned transaction_id to chain the back scan, face match and liveness steps.

Authentication

ApiKeystring

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

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