PAN Card Extraction

Extracts data fields from an Indian PAN card. Provide a PAN card image as input and the response returns the extracted parameters.

POSThttps://sandbox/pcs/pan1

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 PAN card image.
pan_image_required	boolean	No	Return the cropped PAN card image. Defaults to false.
sign_image_required	boolean	No	Return the extracted signature image. Defaults to false.
face_image_required	boolean	No	Return the extracted face image. Defaults to false.

Example

POST/pcs/pan1

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

200

{
"recordId": "1",
"dataRetrievalStatus": "SUCCESS",
"data": {
  "name": "name-string",
  "dob": "dob-string",
  "fatherName": "fathername-string",
  "panNumber": "number-string",
  "panImage": "pan-image-in-base64",
  "signImage": "sign-image-in-base64",
  "faceDetectionStatus": "SUCCESS",
  "faceImage": ""
},
"utc_time_stamp": "25/06/2024, 07:45:32"
}

Response

Field	Type	Description
recordId	string	Echoes the recordId sent in the request.
dataRetrievalStatus	string	SUCCESS when data was extracted.
data.name	string	Holder's name.
data.dob	string	Date of birth.
data.fatherName	string	Father's name.
data.panNumber	string	10-character PAN.
data.panImage	string	Base64 PAN card image, returned only when pan_image_required is true.
data.signImage	string	Base64 signature image, returned only when sign_image_required is true.
data.faceDetectionStatus	string	Outcome of face detection, e.g. SUCCESS.
data.faceImage	string	Base64 face image, returned only when face_image_required is true.
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.