Qatar ID

5 min

Introduction

The Qatar ID extraction API allows you to extract relevant information from the Qatar ID card images. The API uses OCR technology to recognize the text on the image and extract the relevant details.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/....patronid.../foreignidentitiesextractions \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{
    "task": "qatarId",
    "essentials": {
        "files": [
            "...front image url...",
            "...back image url..."
        ]
    }
}'

Input Parameters

Parameter Name	Data Type	Description
task	string	The specific task that needs to be performed, i.e., "qatarId" in this case.
essentials.files	array	The array of files to be used for the extraction process. This array should contain the URLs of the image files.

Sample API Response

   // Expected response
    {
    	"essentials": {
            "files": [
                  "...front image url...",
                  "...back image url..."
              ]
    	},
    	"id": "..id..",
    	"patronId": "...patron id...",
    	"task": "qatarId",
    	"result": {
              "idNumber": "...idNumber...",
              "name": "...name...",
              "dateOfExpiry": "...dateOfExpiry...",
              "nationality": "...nationality...",
              "passportNumber": "...passportNumber...",
              "passportExpiry": "...passportExpiry...",
              "serialNumber": "...serialNumber...",
              "dateOfBirth": "...dateOfBirth..."
    	}
    }

Response Parameters

Parameter	Description
essentials	The file URLs for the front and back images of the ID
id	The ID generated for the verification request
patronId	The patron ID for whom the verification is being performed
task	The task that was requested, which is qatarId in this case
result	The verification result, containing the following fields:
- idNumber	The ID number extracted from the Qatar ID
- name	The name of the ID holder
- dateOfExpiry	The expiry date of the ID
- nationality	The nationality of the ID holder
- passportNumber	The passport number of the ID holder, if available
- passportExpiry	The passport expiry date of the ID holder, if available
- serialNumber	The serial number of the ID
- dateOfBirth	The date of birth of the ID holder