For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
HomeAPI Reference
HomeAPI Reference
  • Overview
    • API Overview
  • Vlens API
      • POSTScan national ID front
      • POSTScan national ID back
      • POSTPerform liveness check
      • GETList user identity image references
      • GETDownload verification image (base64)
      • POSTLink user to existing OCR transaction
Dashboard
LogoLogo
Vlens APIDigital Identity

Scan national ID front

||View as Markdown|
POST
https://api.vlenseg.com/api/DigitalIdentity/verify/id/front
POST
/api/DigitalIdentity/verify/id/front
$curl -X POST https://api.vlenseg.com/api/DigitalIdentity/verify/id/front \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "image": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
>  "transaction_id": null,
>  "getExtractedData": true
>}'
200Digital Identity_verifyIdFront_example
1{
2  "services": {
3    "spoofing": {
4      "fake": false
5    },
6    "classification": {
7      "doc_type": "national_id"
8    }
9  },
10  "data": {
11    "isVerificationProcessCompleted": false,
12    "isDigitalIdentityVerified": null,
13    "idFrontData": {
14      "first_name": "Ahmed",
15      "last_names": "Mohamed Ali",
16      "idNumber": "29901234567890",
17      "dateOfBirth": "1999-01-15T00:00:00Z",
18      "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
19    }
20  },
21  "error_code": null
22}
Submit a base64-encoded image of the **front side** of the user's Egyptian national ID for OCR extraction and validation. On the first call, omit `transaction_id` — a new transaction is created and its ID is returned in the response data. Pass this `transaction_id` to all subsequent steps (`id/back`, `liveness/multi`). Set `getExtractedData: true` to receive the full OCR result (name, date of birth, address, etc.) in `data.idFrontData`.
Was this page helpful?
Previous

Verify OAuth token (skip email at registration)

Next

Scan national ID back

Built with

Submit a base64-encoded image of the front side of the user’s Egyptian national ID for OCR extraction and validation.

On the first call, omit transaction_id — a new transaction is created and its ID is returned in the response data. Pass this transaction_id to all subsequent steps (id/back, liveness/multi).

Set getExtractedData: true to receive the full OCR result (name, date of birth, address, etc.) in data.idFrontData.

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

Scan result. Check data.isVerificationProcessCompleted — it becomes true once all three steps are done.

servicesobject
Results from the various backend verification services.
dataobject
Combined result of the Digital Identity verification process.
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null