V1Generate OTP

Aadhaar eKYC V1 — Send OTP

Send an OTP to the user's Aadhaar-linked mobile number for identity verification. Requires a valid session ID and captcha response.

curl -X POST "https://production.deepvue.tech/v1/ekyc/aadhaar/generate-otp?aadhaar_number=example_string&captcha=example_string&session_id=example_string&consent=example_string&purpose=example_string" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "client-id: YOUR_API_KEY"
{
  "code": 200,
  "timestamp": 1738243998047,
  "transaction_id": "718e0fb212ed4c518398b96f4d09e58c",
  "sub_code": "SUCCESS",
  "message": "OTP sent to your Registered Mobile number. Check your mobile."
}
POST
/v1/ekyc/aadhaar/generate-otp
POST
API Key (header: x-api-key)
x-api-keystring
Required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.
API Key (header: client-id)
client-idstring
Required

The CLIENT_ID provided to you. This header parameter is required for authentication purposes.

The CLIENT_ID provided to you. This header parameter is required for authentication purposes.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
x-api-keystring
Required

API Key for authentication. The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

header
client-idstring
Required

API Key for authentication. The CLIENT_ID provided to you. This header parameter is required for authentication purposes.

Query Parameters

Responses

codeinteger
timestampinteger
transaction_idstring
sub_codestring
messagestring

If a customer or platform needs to restart, you can use the Reload Captcha API to generate a fresh captcha for a new attempt.

Per UIDAI regulations, service providers shall not share, publish, or display either the share code or XML file or its contents with anyone else. Non-compliance invites penalties under multiple sections of The Aadhaar Act and related regulations (2016).

Consent must be mandatorily stored at your end before proceeding with verification.