Skip to main content
POST
/
kyc
/
aadhaar
/
okyc
/
otp
curl --request POST \
  --url https://test-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": "in.co.sandbox.kyc.aadhaar.okyc.otp.request",
  "aadhaar_number": "123456789012",
  "consent": "y",
  "reason": "For KYC"
}
'
{
  "code": 200,
  "timestamp": 1000000000000,
  "transaction_id": "7d75d9db-0870-4719-8884-a3eee7bd68d5",
  "data": {
    "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response",
    "reference_id": 1234567,
    "message": "OTP sent successfully"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt

Use this file to discover all available pages before exploring further.

https://mintcdn.com/sandboxfinancialtechnologiesprivatelimited/gviqebbpT5NUt_6i/static/svg/Postman.svg?fit=max&auto=format&n=gviqebbpT5NUt_6i&q=85&s=da47f2b7e10d87befec951aed9468de3

Run in Postman

Headers

ā€‹
Authorization
string
required

JWT access token. For token-generation steps, refer to the Quickstart Guide.

ā€‹
x-api-key
string
required

API key used to identify and authenticate the client.

ā€‹
x-api-version
string

Specifies the API version for the request.

ā€‹
Content-Type
enum<string>

Media type of the request body.

Available options:
application/json

Body

application/json
ā€‹
@entity
enum<string>
required
Available options:
in.co.sandbox.kyc.aadhaar.okyc.otp.request
ā€‹
aadhaar_number
string
required

12-digit Aadhaar number of the individual for whom the OTP will be generated. Must contain exactly 12 numeric digits with no spaces or separators.

Required string length: 12
Pattern: ^[0-9]{12}$
ā€‹
consent
enum<string>
required

Explicit consent from the end user to use their Aadhaar details for OTP-based verification. Must be passed as "Y" or "y" to proceed.

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

Purpose for initiating Aadhaar OTP verification, such as identity verification or KYC compliance. Used for audit, compliance, and request traceability.

Response

ā€‹
code
integer
required
ā€‹
timestamp
integer
required
ā€‹
transaction_id
string<uuid>
required
ā€‹
data
object
required