Aadhaar Front Extraction

Request Method :: POST

Description: This API facilitates the extraction of the provided Aadhaar Front 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 Front 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 Front 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.
DOB	Date of Birth of the user.	string
aadhaarNumber	User’s Aadhaar Number.	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
aadhaarNumber	Extracted Aadhaar Number Details
confidence	Accuracy of the extracted Aadhaar Number.	number
isVerified	Is Verified or not.	boolean
text	Extracted Aadhaar Number.	String
gender	Extracted Gender Details
confidence	Accuracy of the extracted Gender.	number
text	Extracted Gender.	String
issueDate	Extracted Date of issue details
confidence	Accuracy of the extracted Issue Date	number
text	Extracted Issue Date	String
name	Extracted Name Details
confidence	Accuracy of the Extracted Name	number
text	Extracted Name	String
photo	Extracted Photo Details
confidence	Accuracy of the Extracted Photo	number
vid	Extracted VID Details
confidence	Accuracy of the extracted VID.	number
text	Extracted VID	String
father	Name of Father	string
gender	Gender	string
idType	ID Type. Will be "AADHAARFRONT" in this case.	String
issueDate	Date of Aadhaar Issue.	String
name	Name	String
validate	Validate 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": { "DOB": "01/01/1985", "aadhaarNumber": "287255591132", "confidence": 0.92, "details": { "DOB": { "confidence": 0.92, "text": "01/01/1985" }, "aadhaarNumber": { "confidence": 0.87, "isVerified": false, "text": "287255591132" }, "gender": { "confidence": 0.89, "text": "MALE" }, "issueDate": { "confidence": 0.89, "text": "7/1/2019" }, "name": { "confidence": 0.88, "text": "Gulab Yadav" }, "photo": { "confidence": 0.98 }, "vid": { "confidence": 0, "text": "" } }, "father": "", "gender": "MALE", "idType": "AADHAARFRONT", "issueDate": "7/1/2019", "name": "Gulab Yadav", "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 AADHAARFRONT Document Not Detected From Image (Image Shapness 23.9).", "message": "Valid AADHAARFRONT Document Not Detected From Image (Issues with the image quality of valid AADHAARFRONT documents).", "status": -1 }

Classification Failed:

{ "code": "435", "data": null, "devMsg": "Unable to classify Aadhaar Front.", "message": "Aadhaar Bottom Front 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 AADHAARFRONT Document Not Detected From Image (Issues with the image quality of valid AADHAARFRONT documents).
-1	435	Aadhaar Bottom Front Document not in the correct format.