UAE Visa Extraction

Extracts ID number, file number, place of issue, passport number, name, profession, sponsor, issue date and expiry date from a UAE visa.

POSThttps://sandbox/pcs/UAEVisa

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 UAE visa image.

Example

POST/pcs/UAEVisa

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

200

{
"recordId": "1",
"dataRetrievalStatus": "SUCCESS",
"data": {
  "idNumber": "787878789000000",
  "fileNo": "123/1234/1/123456",
  "placeOfIssue": "place-string",
  "passportNumber": "AB1234567",
  "name": "name-string",
  "profession": "CARPENTER",
  "sponsor": "SPONSOR-STRING",
  "issueDate": "12/06/2024",
  "expiryDate": "08/06/2026"
},
"utc_time_stamp": "06/08/2024, 05:57:16"
}

Response

Field	Type	Description
recordId	string	Echoes the recordId sent in the request.
dataRetrievalStatus	string	SUCCESS when data was extracted.
data.idNumber	string	Visa file / ID number.
data.fileNo	string	Immigration file number.
data.placeOfIssue	string	Place the visa was issued.
data.passportNumber	string	Holder's passport number.
data.name	string	Holder's name.
data.profession	string	Holder's declared profession.
data.sponsor	string	Sponsoring company or individual.
data.issueDate	string	Issue date, 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.