Skip to main content
POST
/
kyc
/
aadhaar
/
okyc
/
otp
Aadhaar Offline e-KYC Generate OTP
curl --request POST \
  --url https://api.sandbox.co.in/kyc/aadhaar/okyc/otp \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "@entity": "<string>",
  "aadhaar_number": "<string>",
  "consent": "Y",
  "reason": "<string>"
}'
{
  "code": 200,
  "timestamp": 1763725205000,
  "transaction_id": "77f8532a-65aa-4d50-b3df-03abb48c1a09",
  "data": {
    "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response",
    "reference_id": 1234567,
    "message": "OTP sent successfully"
  }
}

Headers

ā€‹
Authorization
string
required

JWT access token

ā€‹
x-api-key
string
required

API key for identification

ā€‹
x-api-version
string

Body

application/json
ā€‹
@entity
string
required
Allowed value: "in.co.sandbox.kyc.aadhaar.okyc.otp.request"
ā€‹
aadhaar_number
string
required

12-digit number issued by the UIDAI

Required string length: 12
ā€‹
consent
enum<string>
required

Consent of the end-user to get their information for verification purposes.

Available options:
Y,
y
ā€‹
reason
string
required

Indicate the purpose for verification.

Response

200 - OK

  • OTP Generated
  • OTP Already Generated
ā€‹
code
integer
ā€‹
timestamp
integer
ā€‹
transaction_id
string
ā€‹
data
object