API Reference

Generate OTP

post deprecated
https://api.sandbox.co.in/kyc/aadhaar/okyc/otp

Generate OTP on the individual's registered mobile number to verify their Aadhaar number.

❗️

This API is deprecated and may shut down anytime. Use the DigiLocker API for KYC with multiple documents, including Aadhaar.

Important Links
Run in PostmanStart a Free Trial
Collapsible HTML Table
Response Entity
Key Type Description Example
reference_id string ID to be used when calling Aadhaar OKYC Verify OTP API 10683915
message string Status of OTP generation OTP sent successfully
Collapsible Table
Test Cases

Test Environment: https://test-api.sandbox.co.in

Run in Postman Response Code
OTP sent successfully 200
OTP sent successfully | Invalid OTP 200
OTP sent successfully | OTP Expired 200
OTP sent successfully | Invalid Reference ID 200
OTP Generated | Request under process 200
Invalid Aadhaar Card 200
OTP generated for this Aadhaar, please try after 45 sec 200
Invalid Aadhaar number pattern 422
Body Params
string
required
Defaults to in.co.sandbox.kyc.aadhaar.okyc.otp.request

Entity name

string
required

12-digit number issued by the UIDAI

string
required

Consent of the end-user to get their information for verification purposes. Possible values: Y or y

string
required

Indicate the purpose for verification.

Headers
string
required

JWT access token

string
required

API key for identification

string
required
Defaults to 2.0

API version

Responses

Updated 8 months ago

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

Updated 8 months ago