Aadhaar OKYC v2: verify OTP

Step 2 of 2. Verifies the OTP against the session_id returned by /v2/verify/okyc_generate_otp and returns the canonical Aadhaar identity data on success.

Response contract: a successful verification returns HTTP 200 with status: "success", error_code: null, and a populated data object. Only a raised error returns status: "error". Every response carries billed (whether the call was charged). photo, when present, is base64-encoded. Authenticate with your X-Client-ID and X-API-KEY headers.

Codes: IDTO_205 (wrong OTP or expired session, 422, not billed), IDTO_206 (maximum of 5 OTP verification attempts exceeded for this session_id, 429, not billed, generate a new OTP), IDTO_001 (empty or malformed session_id/otp; 400, or 422 if the request body fails schema validation), IDTO_004 (duplicate verification reference, 409), IDTO_009 (insufficient credits, 402), IDTO_006 (rate limited, 429), IDTO_007 (config error, 500), IDTO_008 (service busy, 503).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The session_id returned by /v2/verify/okyc_generate_otp.

string
required

The OTP the user received on their Aadhaar-linked mobile.

string | null

Optional caller-supplied end-user identifier.

string | null

Optional Workflow V2 session token; when present, billing is attributed to the session instead of this call.

Responses

401

Missing or invalid authentication credentials (X-Client-ID / X-API-KEY).

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json