Generate OTP to Verify Aadhaar
Use this API to generate OTP for a given aadhar number. The mobile number linked with the aadhaar information will receive the generated OTP. Use the generated OTP for offline aadhaar verification. 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 | OTP sent successfully | Enter the OTP in the Submit OTP to Verify Aadhaar API. |
| 200 | SUCCESS | Aadhaar not linked to mobile number | Enter a valid aadhaar number linked to a mobile number to generate the OTP. |
| 200 | SUCCESS | Invalid Aadhaar Card | Enter a valid aadhaar number. |
| 400 | ERROR | aadhaar Number should contain 12 characters. | Enter a valid aadhaar number that has only 12 numeric digits. |
| 400 | ERROR | Please enter aadhaar number in numeric format | Enter a valid aadhaar number that has only 12 numeric digits. |
| 400 | ERROR | Please enter aadhaar number in the request | Enter a valid aadhaar number. |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 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://docs.cashfree.com/docs/ip-whitelisting-verification | Whitelist the IP address. |
| 409 | ERROR | Otp generated for this aadhaar, please try after some time | Try again after some time. |
| 422 | ERROR | Insufficient balance to process this request. | Ensure you have sufficient balance and then process the request. |
| 500 | ERROR | something went wrong | Try again 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.
Body
Find the request parameters to generate an OTP for aadhaar verification
It is the unique 12-digit identification number issued by the Unique Identification Authority of India (UIDAI).
Response
Success response for Generate OTP to Verify Aadhaar API
It displays the unique ID created by Cashfree Payments for reference purposes.
It displays the status of the API request.
It displays details about the success or failure of the API request.
Was this page helpful?