PAN Extraction

Request Method :: POST

Description: This API facilitates the extraction of the provided Pan image. Extraction is initiated only if the request includes the appropriate Client Credentials in the headers, with corresponding privileges verified from the JWT.
The supported input formats for the Pan image are as follows:

JSON Format : The image is provided as a URL within a JSON payload.
Base64 Format : The image is provided as a Base64-encoded string.
File Format : The image is uploaded as a file using multipart form data.

Each format serves different use cases, enabling flexibility for integration with various systems. The API ensures secure access by validating Client Credentials and corresponding privileges before proceeding with the extraction process

Headers

Content-Type: application/JSON

header_secrets: To be shared during integration by ISU Team

pass_key: To be shared during integration by ISU Team

Request Body Parameters

Parameters	Parameter description with validations and examples	Data type	Mandatory/Optional
image	PAN Image Input key (JSON format with URL). E.g. - "https://firebasestorage.googleapis.com/..."	String	Mandatory

Sample Request Body

{ "image": "https://firebasestorage.googleapis.com/..." }

Encrypted Sample Request Body

{ "RequestData": " vYK942PIjdCzQQGOY9polPx7RogzKDqVIycX3Qeddtz8KgMr+4jKVp8yz4dkyZBvUYoQ0lWJMfRIh4QqNpj kL/0y8J2HScJdYULXPwyiRKg=" }

Response Body Parameters

Parameters	Parameter description with examples	Data type
code	Status of the performed action.	String
data	Description of the other items on the document.
DOB	Date of Birth of the user.	string
confidence	Extraction Accuracy	number
details	This section contains different extracted labels in the documents and the accuracy with which the extraction process is done.	String
confidence	Extraction Accuracy	number
details	This section contains different extracted labels in the documents and the accuracy with which the extraction process is done.
DOB	Extracted DOB Details
confidence	Accuracy of the extracted DOB.	number
text	Extracted DOB	string
fatherName	Extracted Father Name Details
confidence	Accuracy of the extracted Father’s Name.	number
text	Extracted Name of Father.	string
name	Extracted Name Details
confidence	Accuracy of the extracted Name.	number
text	Extracted Name.	string
pan	Extracted PAN Details
confidence	Accuracy of the extracted PAN.	number
text	Extracted PAN.	String
fatherName	Name of Father.	String
idType	ID Type. Will be "PAN" in this case.	string
name	Name.	string
pan	PAN Number.	string
devMsg	The developer message, after the operation.	string
message	Front-end message displayed after the operation.	string
status	Status of the operation. 0 denotes a Successful Request. -1 denotes an Unsuccessful Request.	number

Sample Response Body

SUCCESS:

{ "code": "200", "data": { "DOB": "01/01/1985", "confidence": 0.92, "details": { "DOB": { "confidence": 0.87, "text": "01/01/1985" }, "fatherName": { "confidence": 0.87, "text": "SOHAR YADAV" }, "name": { "confidence": 0.78, "text": "GULAB YADAV" }, "pan": { "confidence": 0.7, "text": "AQUPY9624J" } }, "fatherName": "SOHAR YADAV", "idType": "PAN", "name": "GULAB YADAV", "pan": "AQUPY9624J" }, "devMsg": "'WARNING:JSON response body will be changed soon.Please update the frontend accordingly'", "message": "Data retrieved successfully", "status": 0 }

FAILED:

Segmentation Failed:

{ "code": "400", "data": "None", "devMsg": "Segementation/Image Cropping Failed", "message": "Please Try Again", "status": -1 }

No Input Image:

{ "code": "400", "data": null, "devMsg": "Invalid Request", "message": "Invalid Request", "status": -1 }

Issue with Image Quality:

{ "code": "422", "data": null, "devMsg": "Valid PAN Document Not Detected From Image (Image Shapness 15.31).", "message": "Valid PAN Document Not Detected From Image (Issues with the image quality of valid PAN documents).", "status": -1 }

Classification Failed:

{ "code": "435", "data": null, "devMsg": "Unable to classify PAN.", "message": "PAN Bottom Back Document not in the correct format.", "status": -1 }

Encrypted Sample Response Body

{ "ResponseData":"EE6V+m0GHnGryRZhcE0XRbqAayBqTPJSX/ lFalXrNsKSIoqaALdLAmrb0cfh3LDKKJlQnazu+rKp6OS9PqEuwpAFtbwtq2DPRy9INcqmiEBh1kzroDVD9 Vc9sN6y" }

Status Codes and description

Status	HTTP Code	Description
0	200	Data retrieved successfully
-1	400	Please Try Again
-1	400	Invalid Request
-1	422	Valid PAN Document Not Detected From Image (Issues with the image quality of valid PAN documents).
-1	435	PAN Bottom Back Document not in the correct format.