Verify Aadhaar OTP

KYC Verification API

Verifies Aadhaar OTP against the latest generated Aadhaar OTP session.

Request URL
POST
https://ekyc.nerotix.in/api/v1/service/aadhaar/otp/verify
Authentication Required REQUIRED

Pass a valid Bearer Token in the Authorization header with every request.

Authorization: Bearer YOUR_BEARER_TOKEN
Parameters
Name Type Description
otp required numeric 6 Digit OTP received on registered mobile number
ref_id required string Reference ID received from the OTP generation API
Request Body
application/json 
{
    "otp": "ABC123456",
    "ref_id": "15665553"
}
Response Examples

API Response

Sample responses returned by the Aadhaar OTP Verification API.

Successful Response

Success
Aadhaar card successfully verified
HTTP 200 OK
application/json 
{
    "success": true,
    "statusCode": 1,
    "message": "Verification Successfully Completed",
    "data": {
        "ref_id": "15665553",
        "full_name": "Rahul",
        "aadhaar_number": "123456789123",
        "dob": "2001-10-06",
        "gender": "M",
        "address": {
            "country": "India",
            "dist": "Gwalior",
            "state": "Madhya Pradesh",
            "po": "Gwalior City",
            "loc": "gwalior",
            "vtc": "Gird",
            "subdist": "Gird",
            "street": "",
            "house": "",
            "landmark": ""
        },
        "face_status": false,
        "face_score": -1,
        "zip": "474003",
        "profile_image": "/9j/4AAQSkZJRgA7k+Wiwg89TUkY4AAwABwBwB7VSBVSOTnNFFAyW4l/coi9+TUcK9zRRQInTrUUnMhoooARMg0yTiQ0UUAIOoqTPyiiigD//Z",
        "has_image": true,
        "email_hash": "",
        "mobile_hash": "d756f94ca11c5657115ab1da42f401aa8aacc5589767eb328184ef0d6030967f",
        "raw_xml": "",
        "zip_data": "Z0TCDJncMMG10EaXkpd5RQlD4W2EUeAYD3kNDIyMTAyLnhtbFBLBQYAAAAAAQABAFEAAADxHgAAAAA=",
        "care_of": "S/O: Vrandavan",
        "share_code": "6575",
        "mobile_verified": false,
        "aadhaar_pdf": null,
        "status": "success_aadhaar"
    }
}

Invalid Response

Invalid
Invalid Aadhaar OTP or Reference ID
HTTP 200 OK
application/json 
[]
Note Please keep the following points in mind while integrating this API.
  • The API endpoint should be accessed via a POST request.
  • Ensure that the request is properly validated and sanitized to prevent security vulnerabilities.
  • Implement proper error handling on the client side to display user-friendly error messages based on the 'statusCode' and 'message' fields in the response.
  • Always include a valid Bearer Token in the Authorization header when making API requests.
  • The profile_image must be provided in Base64 encoded format. If you want to view the profile_image, you need to decode the Base64 value and convert it back to an image