Aadhaar Verification via OCR

Use this API to extract the details of a customer from the respective aadhaar card image and return it to the business for verification or for KYC requirements. View the test data and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.

Response Codes

Sub Code	Status	Message	Next Action
200	SUCCESS	Aadhaar card is valid	-
200	SUCCESS	Aadhaar card is invalid	Upload a valid aadhaar copy.
400	ERROR	file size exceeded	The max file size of both the files is 10MB.
400	ERROR	please upload the file of valid format(jpeg/jpg/png)	Allowed file type - JPEG/JPG/PNG.
400	ERROR	verification_id is missing in the request.	Enter a unique verification ID in the request.
400	ERROR	Front Image File is missing	Upload the scanned image of the front of the aadhaar card.
400	ERROR	verification_id can include a maximum of 50 characters.	Enter a unique verification ID within 50 characters.
400	ERROR	Client secret belongs to test environment	Enter the correct environment credentials in the request.
400	ERROR	verification_id can include only alphanum, dot, hyphen and underscores.	Only alphanumeric, hyphen (-), period (.), and underscore ( _ ) are allowed.
400	ERROR	x-client-id is missing in the request	Enter all the header information in the API request.
401	ERROR	Invalid clientId and clientSecret combination	Enter valid client ID and secret key in the request.
403	ERROR	IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification	Whitelist the IP address.
422	ERROR	Insufficient balance to process this request.	Ensure you have sufficient balance and then process the request.
500	ERROR	something went wrong	Try after some time.

Authorizations

x-client-id · string · header · required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret · string · header · required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-api-version · string

It is the API version. To receive the aadhaar seeding status in the response, use any date after 2022-09-12

x-cf-signature · string

Send the signature if IP is not whitelisted

Body

multipart/form-data

Find the request parameters to extract the details of a customer from the aadhaar card image

Request body schema for Aadhaar Verification via OCR.

verification_id · string · default: 12345678 · required

It is the unique ID you create to identify the request. The maximum character limit is 50. Only alphanumeric, hyphen (-), period (.), and underscore ( _ ) are allowed.

Example:

"12345678"

front_image · file · required

It is the scanned image of the front of the aadhaar card. Allowed file type - JPEG/JPG/PNG. The max file size of both the files is 10MB.

back_image · file

It is the scanned image of the back of the aadhaar card. Allowed file type - JPEG/JPG/PNG. The max file size of both the files is 10MB.

Response

200

application/json

Success response for verifying aadhaar information

Success response for Aadhaar Verification via OCR

name · string

It displays the name of the aadhaar card holder.

Example:

"John Doe"

yob · string

It displays the year of birth of the aadhaar card holder.

Example:

"2000"

father · string

It displays the father's name of the aadhaar card holder.

Example:

"Jone Doe"

gender · string

It displays the gender of the aadhaar card holder.

Example:

"Male"

uid · string

It displays the UID information as present in the aadhaar card.

Example:

"123456789012"

state · string

It displays the name of the state as present in the aadhaar card.

Example:

"Madhya Pradesh"

pincode · string

It displays the PIN code information as present in the aadhaar card.

Example:

"453551"

address · string

It displays the address information of the aadhaar card holder.

Example:

"4th cross road Koramangala"

valid · boolean

It displays whether the aadhaar card is valid or not.

Example:

true

status · string

It displays the status of the aadhaar card.

Example:

"VALID"

reference_id · string

It displays the unique ID created by Cashfree Payments for reference purposes.

Example:

"123456"

verification_id · string

It displays the unique ID you created to identify this request.

Example:

"123467"

confidence_score · string

It displays the confidence score for this aadhaar card verification request.

Example:

"0.98"

message · string

It displays details about the success or failure of the API request.

Example:

"valid"