Skip to content

Aadhaar. Send OTP

Request

Use this endpoint to start the Aadhaar check of an Indian citizen. The Aadhaar check has 2 steps:

  1. Send OTP. You send the Aadhaar number. The Aadhaar registry (UIDAI) sends a one-time password (OTP) to the mobile number that is linked to this Aadhaar number. Our system returns service_request_id.
  2. Submit OTP. The applicant gives you the OTP. You send the OTP and service_request_id to POST /services/in/aadhaar/submit-otp. Our system returns the personal data from the Aadhaar registry.

service_request_id is valid for 1 hour.

Our system does not charge this request when the OTP is sent. Our system charges this request when the registry reports that the Aadhaar number is not valid (validation.valid is false in the 200 response).

Security
API-Key
Bodyapplication/jsonrequired
aadhaar_numberstring^\d{12}$required

Aadhaar number, 12 digits

Example:"234567890120"
{
  "aadhaar_number": "234567890120"
}

Responses

OK

The request was successful, and our system returned an expected response.

When validation.valid is true, the OTP is sent. Use service_request_id in the next step.

Bodyapplication/json
validationobject
dataobject
Response
{
  "validation": {
    "valid": true
  },
  "data": {
    "aadhaar_number": "234567890120",
    "otp_sent": true,
    "service_request_id": "6f1c2a4e18b3d04e5f09a7b71c2d3e4f5a6b"
  }
}