/verify/validate_aadhaar_otp

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

This API is used to get and validate the user's e-kyc data.

Request Method

POST

Request URL

https://cloudapi.accuauth.in/verify/validate_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 client_id String The client ID received during OTP generation
required otp_code String OTP received by the user

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 verification session
full_name string Name of the Aadhaar holder
aadhaar_number string Aadhaar number
dob string Date of birth (YYYY-MM-DD)
gender string Gender (M/F/O)
address object Complete address details
face_status bool Face verification status
face_score float Face score value
zip string PIN code
profile_image string Base64 encoded image string
has_image bool Availability of profile image
email_hash string Email hash if available
mobile_hash string Mobile hash
raw_xml string Download link for raw XML
zip_data string Download link for ZIP data
care_of string C/O field (care of)
share_code string Share code used during Aadhaar verification
mobile_verified bool Mobile verified status
reference_id string Unique reference ID
aadhaar_pdf string Aadhaar PDF link if available
status string Verification status
uniqueness_id string Unique identifier for uniqueness tracking
Response Syntax
{
    "status": "OK",
    "result": {
        "client_id": "aadhaar_v2_QfRkVdgeyJwsUrQlNWll",
        "full_name": "Saravjeet Singh",
        "aadhaar_number": "954077169168",
        "dob": "2000-10-01",
        "gender": "M",
        "address": {
            "country": "India",
            "dist": "South Delhi",
            "state": "Delhi",
            "po": "Chattarpur",
            "loc": "CHHATARPUR EXTENSION",
            "vtc": "Chattar Pur",
            "subdist": "",
            "street": "NEAR DURGA ASHRAM",
            "house": "421/3",
            "landmark": "Durga Ashram"
        },
        "face_status": false,
        "face_score": -1,
        "zip": "110074",
        "profile_image": "<Base64 Image String>",
        "has_image": true,
        "email_hash": "",
        "mobile_hash": "184c11fedba8cafc07a1bf82b27cf6bb3d1090401c7b2aba56c522505f72b926",
        "raw_xml": "<XML File Download Link>",
        "zip_data": "<ZIP File Download Link>",
        "care_of": "C/O NARENDER SINGH",
        "share_code": "0838",
        "mobile_verified": false,
        "reference_id": "916820240925172114494",
        "aadhaar_pdf": null,
        "status": "success_aadhaar",
        "uniqueness_id": "86295a35177e1d3b7f544e4fbd50d4ad5f5ce3e9931a4e8ca682bc3bf7b97221"
    }
}

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
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": "otp_code is required",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

results matching ""

    No results matching ""