Sign in

v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB
OKYC

Generate OKYC OTP

Generates an OTP for Aadhaar offline KYC. Requires X-Client-ID and X-API-KEY headers.

post/verify/okyc_generate_otp

Request body

aadhaar_numberstring required

12 digit Aadhaar number.

user_idstring nullable

Optional customer-side user identifier for tracking.

Example request

{
  "aadhaar_number": "327796541243"
}

Response

OTP generated successfully.

messagestring required

OTP delivery message.

sessionIdstring required

Session ID returned by OTP generation and required for OTP verification.

sessionActiveboolean required

Whether the OTP session is active.

Example response

{
  "message": "OTP sent on linked mobile no",
  "sessionId": "87d02abb-ece3-4b76-a8fe-cd08292e1330",
  "sessionActive": true
}