Documents OCR

Sending a document image to be identified - Base URL: api.vlenseg.com/v1

General Input For Any Request

POST https://api.vlenseg.com/v1/<endpoint_path>

Headers

Name	Type	Description
Content-Type*	string	application/json
ApiKey*	string	API Key

Request Body

Name	Type	Description
image*	string	The base 64 encoding of the document image
transaction_id	GUID	The transaction Id. Required if this image belongs to an existing transaction. If null then a new transaction Id will be generated and returned in the response to be used in subsequent requests for the same transaction.
client_transaction_id	string	Any client generated Id that is recognized and used by the client. It will be returned in the response as is.

200 success

{
  "data": <Data model according to each model described below>,
  "Services": {
      "Validations": {
        "validation_errors": [
          {
            "field": <string>,
            "value": <string>,
            "errors": [
              {
                "code": <int>,
                "message": <string>
              }
            ]
          }
        ]
      },
      "spoofing": {
        "fake": <bool>
      },
      "classification": {
        "doc_type": <string>
      }
    }
  },
  "error_code": <int>,
  "error_message": <string>
}

400: Bad Request

401: Unauthorized

{
  "data": null,
  "Services": null,
  "error_code": 401,
  "error_message": "Unauthorized – invalid API Key"
}

National ID front side

Sends National ID Front Image

POST https://<base-url>/ocr/id/front

Use parameters mentioned in general input above, check the data model in responses below.

200: OK Data model for ID front image

{
  "data": {
      "name": <string>,
      "address": <string>,
      "first_name": <string>,
      "last_names": <string>,
      "first_name_english": <string>,
      "last_names_english": <string>,
      "govern": <string>,
      "idKey": <string>,
      "dateOfBirth": <date>,
      "address_1": <string>,
      "address_2": <string>,
      "idNumber": <string>,
      "gender": <string>,
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

National ID back side

Sends National ID Back Image

POST https://<base-url>/ocr/id/back

Use parameters mentioned in general input above, check the data model in responses below.

200: OK Data model for ID back image

{
  "data": {
      "job": <string>,
      "jobTitle": <string>,
      "religion": <string>,
      "maritalStatus": <string>,
      "husbandName": <string>,
      "releaseDate": <date>,
      "idExpiry": <date>,      
      "idNumber": <string>,
      "gender": <string>,
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

Car License front side

Sends Car License Front Image

POST https://<base-url>/ocr/car/license/front

Use parameters mentioned in general input above, check the data model in responses below.

200: OK Data model for Car License Front image

{
  "data": {
      "traffic_unit": <string>,
      "license_number": <string>,
      "license_type": <string>,
      "name": <string>,
      "name_2": <string>,
      "nationality": <string>,
      "address": <string>,      
      "expiry": <date>,
      "issuance": <date>,
      "front_special": <string>,      
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

Car License back side

Sends Car License Back Image

POST https://<base-url>/ocr/car/license/back

Use parameters mentioned in general input above, check the data model in responses below.

200: OK Data model for Car License back image

{
  "data": {
      "model_year": <string>,
      "type": <string>,
      "sub_type": <string>,
      "sub_type_2": <string>,
      "chasis": <string>,
      "volume": <string>,
      "motor": <string>,      
      "color": <string>,
      "fuel": <string>,
      "cylinder": <string>,
      "special_1": <string>,
      "examination_dt": <string>,
      "special_2": <string>,
      "special_3": <string>,
      "special_4": <string>,       
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

Passport

Sends Passport Image

POST https://<base-url>/ocr/passport

200: OK Data model for Passport image

{
  "data": {
      "Date_of_Birth": <date>,
      "Date_of_Expiry": <date>,
      "country_code": <string>,
      "doc_Type": <string>,
      "gender": <string>,
      "name": <string>,
      "nationality": <string>,      
      "passport_no": <string>,     
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

Driving License

Sends Driving License Image

POST https://<base-url>/ocr/driving_license

200: OK Data model for Driving License image

{
  "data": {
      "address": <string>,
      "expiryDate": <date>,
      "issuenceDate": <date>,
      "job": <string>,
      "licenseType": <string>,
      "nameArabic": <string>,
      "nameEnglish": <string>,      
      "nationalID": <string>,
      "nationalityArabic": <string>,
      "nationalityEnglish": <string>,
      "trafficUnit1": <string>,
      "trafficUnit2": <string>,
      "special1": <string>,   
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

License Plate

Sends License Plate Image

POST https://<base-url>/ocr/license_plate

200: OK Data model for License Plate image

{
  "data": {
      "result": <string>,
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

Multi card

Sends an image containing multiple documents

POST https://<base-url>/ocr/multi

200: OK

{
  "data": {
    "results":[
        {
          "data": <Data model according to each model described below>,
          "Services": <Same services object returned with each result>
        },
        .
        .
      ],   
      "transaction_id": <GUID>,
      "client_transaction_id": <string>,
      "request_id": <GUID>
    },
    .
    .
    .
}

General OCR

Sends any image containing any general text to be recognized and extracted

POST https://<base-url>/ocr/general

200: OK

{
  "data": {
      "lines": [
        {
          "text": <string>
        },
        .
        .
      ]
    },
    .
    .
    .
}

Postman collection for documents OCR

5KB

Docs.postman_collection.json