Qatar ID Front Extraction

Extracts ID number, name, nationality, date of birth and expiry date from the front of a Qatar ID card.

POSThttps://sandbox/pcs/QatarId/front

Content-Type: application/json

Headers

Header	Type	Required	Description
key	string	Yes	API key issued for authentication.

Request body

Field	Type	Required	Description
recordId	string	Yes	Unique ID you assign to correlate the request with the response.
image	string	Yes	Base64 string / data URI of the Qatar ID front image.

Example

POST/pcs/QatarId/front

curl --location 'https://sandbox/pcs/QatarId/front' \
--header 'key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "recordId": "1",
  "image": "data:image/png;base64,<BASE64_STRING>"
}'

200

{
"recordId": "1",
"data": {
  "idNumber": "12345678912",
  "name": "name-string",
  "nationality": "nationality-string",
  "DOB": "07/03/1990",
  "expiryDate": "30/11/2029"
},
"utc_time_stamp": "07/11/2024, 07:35:09"
}

Response

Field	Type	Description
recordId	string	Echoes the recordId sent in the request.
data.idNumber	string	Qatar ID number.
data.name	string	Holder's name.
data.nationality	string	Holder's nationality.
data.DOB	string	Date of birth, DD/MM/YYYY.
data.expiryDate	string	Expiry date, DD/MM/YYYY.
utc_time_stamp	string	UTC timestamp of the response, DD/MM/YYYY, HH:mm:ss.

Error handling

200 on success, 422 on a validation error — see Error handling for the common error shape.