Skip to main content

Passport Back Extraction

Extracts data fields from the back page of an Indian passport. Provide a passport back image as input and the response returns the extracted parameters.

POSThttps://sandbox/pcs/passport/back

Content-Type: application/json

Headers​

HeaderTypeRequiredDescription
keystringYesAPI key issued for authentication.

Request body​

FieldTypeRequiredDescription
recordIdstringYesUnique ID you assign to correlate the request with the response.
imagestringYesBase64 string / data URI of the passport back image.

Example​

POST/pcs/passport/back
curl --location 'https://sandbox/pcs/passport/back' \
--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": {
  "fatherName": "father-name-string",
  "motherName": "mother-name-string",
  "maritalStatus": false,
  "spouseName": "N/A",
  "addressLine1": "address-1",
  "addressLine2": "address-2",
  "addressLine3": "address-3",
  "pinCode": "123456",
  "previousPassport": "N/A",
  "fileNo": "file-details"
},
"utc_time_stamp": "25/06/2024, 07:45:32"
}

Response​

FieldTypeDescription
recordIdstringEchoes the recordId sent in the request.
dataRetrievalStatusstringSUCCESS when data was extracted.
data.fatherNamestringFather's name.
data.motherNamestringMother's name.
data.maritalStatusbooleantrue if the holder is married.
data.spouseNamestringSpouse's name, or N/A.
data.addressLine1 / addressLine2 / addressLine3stringAddress lines.
data.pinCodestringPostal code.
data.previousPassportstringPrevious passport reference, or N/A.
data.fileNostringPassport file number.
utc_time_stampstringUTC 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.