Endpoint Version: 1.0.0 | Cost: ₹2.00 per call
Initiate Aadhaar Verification process by requesting an OTP sent to the linked mobile number.
| Header Name | Value / Type | Description |
|---|---|---|
| Content-Type | string |
application/json |
| X-API-Key | string |
your_api_key |
| Parameter Name | Required Type | Constraint |
|---|---|---|
| aadhaar | string |
12-digit Aadhaar Number |
| Header | Sample Value |
|---|---|
| Content-Type | application/json; charset=utf-8 |
| X-Execution-Time-Ms | 45.82 ms |
| Error Code | Description / Scenario |
|---|---|
| INVALID_AADHAAR | The Aadhaar number is invalid. |
| GATEWAY_TIMEOUT | The verification partner endpoint was unreachable. |
{
"status": "success",
"message": "OTP sent to registered mobile ending with XXXX-1234",
"data": {
"reference_id": "ref_987654321"
}
}
{
"status": "error",
"message": "Invalid Aadhaar number"
}