/verify/indian_aadhaar
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to verify Indian aadhaar card.
Request Method
POST
Request URL
https://cloudapi.accuauth.in/verify/indian_aadhaar
Debugging Tool
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 |
| status | string | Response status, OK for success request, Error Codes for failed request |
| valid | bool | Validation check, true or false |
| result | object | Verification result, it is returned only when valid is true, see Elements in result for detail |
3.1 Elements in result
| Fields | Type | Description |
|---|---|---|
| age_band | string | Age band |
| gender | string | Gender |
| mobile_number | string | Mobile number with mask |
| state | string | State |
Response Syntax
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"result": {
"age_band": "30-40",
"gender": "MALE",
"mobile_number": "xxxxxxx610",
"state": "West Bengal"
},
"valid": true
}
4.Error Codes
Common error codes of this API:
| Http Status Code | Status Field |
Description |
|---|---|---|
400 |
INVALID_ARGUMENT | Request parameter is invalid |
400 |
QUERY_FAILED | Query failed |
400 |
ABNORMAL_BEHAVIOURS_DETECTED | Request with same parameters repeated more than amount of times |
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": "argument 'aadhaar_no': not found",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}