Aadhaar Back Extraction

Request Method :: POST

Description: This API facilitates the extraction of the provided Aadhaar Back 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 Aadhaar Back 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

client_id: To be shared during integration by ISU Team

client_secret: To be shared during integration by ISU Team

Request Body Parameters

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

Sample Request Body

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

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.
aadhaarNumber	User’s Aadhaar Number.	string
address	User’s Address.	String
city	City to which the User belongs to.	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.
aadhaarNumber	Extracted Aadhaar Number Details
confidence	Accuracy of the extracted Aadhaar Number.	number
isVerified	Is Verified or not.	boolean
text	Extracted Aadhaar Number.	String
address	Extracted Address Details
address	Extracted Address	string
confidence	Accuracy of the extracted Address.	number
district	Name of the District.	string
father	Father's Name	string
pincode	PIN Code.	string
state	Name of the State.	String
district	Name of the District.	String
father	Name of Father.	String
idType	ID Type. Will be "AADHAARBACK" in this case.	string
og_add	Date of Aadhaar Issue.	string
pinCode	PIN Code.	string
state	Name of the State.	string
validate	Validated or not.	boolean
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": { "aadhaarNumber": "761864978524", "address": "C/O BIRAKISHORE MAHANTA, RENGALGODA, UCHABALI, CHAMPUA, KARANJIA, Rengalagoda, Kendujhar, Odisha, ", "city": "", "confidence": 0.92, "details": { "aadhaarNumber": { "confidence": 0.87, "isVerified": false, "text": "287255591132" }, "address": { "address": "C/O BIRAKISHORE MAHANTA, RENGALGODA, UCHABALI, CHAMPUA, KARANJIA, Rengalagoda, Kendujhar, Odisha,", "confidence": 0.9, "district": "kendujhar", "father": "BIRAKISHORE MAHANTA", "pincode": "758044", "state": "Odisha" } }, "district": "Kendujhar", "father": "BIRAKISHORE MAHANTA", "idType": "AADHAARBACK", "og_add": "", "pinCode": "758044", "state": "Odisha", "validate": true }, "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 AADHAARBACK Document Not Detected From Image (Image Shapness 23.9).", "message": "Valid AADHAARBACK Document Not Detected From Image (Issues with the image quality of valid AADHAARBACK documents).", "status": -1 }

Classification Failed:

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

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 AADHAARBACK Document Not Detected From Image (Issues with the image quality of valid AADHAARBACK documents).
-1	435	Aadhaar Bottom Back Document not in the correct format.