Get Status of Aadhaar Verification via OCR
Use this API to get the status of the created Aadhaar Verification via OCR request. You need to enter either the reference ID or verification ID to get the status. When you provide both the values, the API prioritises the reference ID.
Response Codes
Sub Code | Status | Message | Next Action |
---|---|---|---|
200 | SUCCESS | Aadhaar card is valid | - |
200 | SUCCESS | Aadhaar card is invalid | - |
200 | SUCCESS | Insufficient balance | Ensure you have sufficient balance before requesting another verification. |
200 | SUCCESS | verification attempt failed | Try again. |
200 | SUCCESS | Insufficient balance | Ensure you have sufficient balance and then verify aadhaar via OCR. |
200 | SUCCESS | verification attempt failed | Use the API to verify again. |
400 | ERROR | x-client-id is missing in the request | Enter all the header information in the API request. |
400 | ERROR | x-client-secret is missing in the request. | Enter all the header information in the API request. |
400 | ERROR | provide verification_id or reference_id | Enter either the verification ID or reference ID in the request. |
400 | ERROR | Bad request, please check API documentation | Enter the correct environment credentials in the 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://docs.cashfree.com/docs/ip-whitelisting-verification | Whitelist the IP address. |
404 | ERROR | reference_id does not exist. | Provide a valid reference ID to get the verification status. |
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
Client ID. You can find your ID in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
Send the signature if IP is not whitelisted
Query Parameters
It is the unique ID created by Cashfree Payments that you receive in the response of Aadhaar Verification via OCR API.
It is the unique ID you created to identify the verification request.
Response
Success response for Aadhaar Verification via OCR
It displays the name of the aadhaar card holder.
It displays the year of birth of the aadhaar card holder.
It displays the father's name of the aadhaar card holder.
It displays the gender of the aadhaar card holder.
It displays the UID information as present in the aadhaar card.
It displays the name of the state as present in the aadhaar card.
It displays the PIN code information as present in the aadhaar card.
It displays the address information of the aadhaar card holder.
It displays whether the aadhaar card is valid or not.
It displays the status of the aadhaar card.
It displays the unique ID created by Cashfree Payments for reference purposes.
It displays the unique ID you created to identify this request.
It displays the confidence score for this aadhaar card verification request.
It displays details about the success or failure of the API request.
Was this page helpful?