Qatar ID Back Extraction

Extracts the passport number, passport expiry and serial number from the back of a Qatar ID card.

POSThttps://sandbox/pcs/QatarId/back

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 back image.

Example

POST/pcs/QatarId/back

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

200

{
"recordId": "1",
"data": {
  "passportNumber": "M2123456",
  "passportExpiry": "25/06/2029",
  "serialNo": "12444333222111"
},
"utc_time_stamp": "07/11/2024, 07:35:09"
}

Response

Field	Type	Description
recordId	string	Echoes the recordId sent in the request.
data.passportNumber	string	Holder's passport number.
data.passportExpiry	string	Passport expiry date, DD/MM/YYYY.
data.serialNo	string	Card serial number.
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.