Skip to main content
POST
/
offline-aadhaar
/
otp
Generate OTP to Verify Aadhaar
curl --request POST \
  --url https://sandbox.cashfree.com/verification/offline-aadhaar/otp \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "aadhaar_number": "655675523712"
}'
{
  "status": "SUCCESS",
  "message": "OTP sent successfully",
  "ref_id": 21637861
}

Authorizations

ā€‹
x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

ā€‹
x-client-secret
string
header
required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

ā€‹
x-cf-signature
string

Send the signature if two-factor authentication is selected as Public Key. More details

Body

application/json

Find the request parameters to generate OTP for a given aadhar number

ā€‹
aadhaar_number
string
default:655675523712
required

It is the unique 12-digit identification number issued by the Unique Identification Authority of India (UIDAI).

Example:

"655675523712"

Response

Success response for generating the OTP for offline aadhaar verification

ā€‹
ref_id
string

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

Example:

"12345"

ā€‹
status
string

It displays the status of the API request. Possible values are:

  • SUCCESS: OTP generated successfully / Aadhaar not linked to mobile number.
  • INVALID: Aadhaar card invalid.
Example:

"SUCCESS"

ā€‹
message
string

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

Example:

"OTP send successfully."