Skip to main content
POST
Discontinued: UIDAI has discontinued Aadhaar offline e-KYC (OKYC), and this endpoint no longer works. To verify an individual’s Aadhaar, use the DigiLocker API to fetch their Aadhaar from DigiLocker with their consent.

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
string
required
Allowed value: "in.co.sandbox.kyc.aadhaar.okyc.request"
reference_id
string
required

Unique reference identifier returned by the Generate OTP API for this Aadhaar verification flow. Used to correlate the OTP submission with the original request.

otp
string
required

6-digit one-time password sent to the mobile number linked with the Aadhaar. Must be entered exactly as received and is valid only for the associated reference_id.

Required string length: 6
Pattern: ^[0-9]{6}$

Response

code
integer
required
timestamp
integer
required
transaction_id
string
required
data
object
required