post https://api.cashfree.com/verification/offline-aadhaar/verify
Use aadhar OTP verification API to verify aadhar by submitting the OTP received on your phone number and the reference ID received in the offline aadhar verification API response.
Click here to view the test data and response codes.
Sample Aadhaar Numbers
Aadhaar Number | OTP | Remarks |
---|---|---|
655675523712 | 111000 | Aadhaar Verification Successfull |
655675523712 | 000111 | OTP Invalid |
655675523712 | 000222 | Verification Failed |
655675523711 | 000113 | OTP Invalid |
655675523710 | 111000 | Invalid Aadhaar Number |
655675523709 | 111000 | Verification Failed |
Response Codes
Sub Code | Status | Message | Next Action |
---|---|---|---|
200 | SUCCESS | Aadhaar Card Exists | - |
400 | ERROR | OTP entered is invalid | Enter a valid OTP. |
400 | ERROR | x-client-id is missing in the request. | Provide the client ID in the request |
400 | ERROR | Please enter the otp in the request | Enter a valid OTP. |
400 | ERROR | Please enter a valid otp. | Enter a valid OTP. |
400 | ERROR | Please enter a valid ref_id | Enter a valid reference ID. |
400 | ERROR | OTP entered is invalid | Enter a valid OTP. |
400 | ERROR | Otp expired | Generate a new OTP and submit before the OTP expires. |
400 | ERROR | Session expired, please generate a new OTP | Generate a new OTP and submit before the session expires. |
400 | ERROR | x-client-id is missing in the request. | Ensure x-client-id is entered in the API request. |
400 | ERROR | Invalid Aadhaar Card | Enter a valid aadhaar number. |
400 | ERROR | Aadhaar not linked to mobile number | Enter a valid aadhaar number linked to the entered mobile number. |
401 | ERROR | Invalid clientId and clientSecret combination | Enter the client ID and client secret key in the API. |
403 | ERROR | IP not whitelisted | Whitelist the IP address. |
409 | ERROR | Otp generated for this aadhaar, please try after some time | Generate a new OTP after 45 seconds. |
422 | ERROR | Insufficient balance to process this request | Add sufficient balance and try again. |
500 | ERROR | Unable to validate, please retry later | Please try after some time. |
500 | ERROR | something went wrong, please try after some time | Please try after some time. |
You can claim free credits to verify your beneficiary details.
Best Practices for Submitting OTP:
- Ensure you always submit the correct OTP.
- If the first Submit OTP API call fails for an Aadhaar due to the wrong OTP entered, wait for 50 seconds before resubmitting the correct OTP for the same Aadhaar.
- If verification fails for an Aadhaar on submitting the correct OTP, please generate a new OTP using the Generate OTP API for the same Aadhaar.
- The average response time is between 8 to 10 seconds.