/verify/send_aadhaar_otp
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to send an OTP to the user associated with the aadhaar number.
Request Method
POST
Request URL
https://cloudapi.accuauth.in/verify/send_aadhaar_otp
2.Request Params
2.1 Request Header
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-DF-API-ID | string | Yes | For API credentials，Please visit API Request |
| X-DF-API-SECRET | string | Yes | For API credentials，Please visit API Request |
2.2 Request Body
| Required | Fields | Type | Description |
|---|---|---|---|
| required | aadhaar_no | string | The aadhaar number |
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| result | object | Result |
| status | string | Response status, OK for success request, Error Codes for failed request |
3.1 Elements in result
| Fields | Type | Description |
|---|---|---|
| client_id | String | Unique client ID for this OTP session |
| otp_sent | bool | Indicates OTP was sent successfully |
| if_number | bool | True if number exist |
| valid_aadhaar | bool | Validity of the Aadhaar number |
| status | bool | Status message |
Response Syntax
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"result": {
"client_id": "aadhaar_v2_TmriSoarBhTC********",
"otp_sent": true,
"if_number": true,
"valid_aadhaar": true,
"status": "generate_otp_success"
},
"status": "OK"
}
4.Error Codes
Common error codes of this API:
| Http Status Code | Status Field |
Description |
|---|---|---|
400 |
INVALID_ARGUMENT | Request parameter is invalid |
400 |
DETECTION_FAILED | Detect image failed |
400 |
DOWNLOAD_ERROR | Image download failed |
401 |
UNAUTHORIZED | Unauthorized or access is denied |
401 |
KEY_EXPIRED | Your API ID has expired |
403 |
NO_PERMISSION | You are not authorized to use this API |
403 |
OUT_OF_QUOTA | API calls quota exceeded |
403 |
RATE_LIMIT_EXCEEDED | API request frequency exceeds the limit |
404 |
NOT_FOUND | Requested API cannot be found |
500 |
INTERNAL_ERROR | Internal server error |
512 |
SOURCE_SERVICE_UNAVAILABLE | Source service is unavailable |
513 |
SOURCE_SERVICE_TIMEOUT | Source service is timeout |
Comment: Please see the reason field for details when the above 40X / 51X error occurred
Response Syntax
{
"status": "INVALID_ARGUMENT",
"reason": "invalid aadhaar_no",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}