V2Verify OTP

Aadhaar eKYC V2 — Verify OTP & Get Data

Verify the OTP and retrieve Aadhaar details with an auto-generated PDF. Includes name, address, DOB, photo, and masked Aadhaar number.

curl -X POST "https://production.deepvue.tech/v2/ekyc/aadhaar/verify-otp?otp=example_string&reference_id=example_string&consent=example_string&purpose=example_string&mobile_number=example_string&generate_pdf=true" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "client-id: YOUR_API_KEY"
{
  "code": 200,
  "timestamp": 1738243999577,
  "transaction_id": "f6efc218742a405c8dd65cf19c13b878",
  "sub_code": "SUCCESS",
  "message": "Aadhaar eKYC Successful",
  "data": {
    "address": {
      "careOf": "S/O H. Nue Mahammed",
      "country": "India",
      "district": "Bangalore",
      "house": "NO. 6",
      "landmark": "",
      "locality": "MTS LAYOUT J X NAGAR 51TH PHASE",
      "pin": "561118",
      "postOffice": "J P Nagar",
      "state": "Karnataka",
      "street": "19TH MAIN",
      "subDistrict": "",
      "vtc": "Bangalore"
    },
    "dateOfBirth": "28-06-1999",
    "email": "e2afb1d691d72a535b501053e6291abdb51c05cccc7c08b4439ab3e",
    "gender": "M",
    "generatedAt": "1738304139979",
    "maskedNumber": "xxxx-xxxx-8091",
    "name": "Mohammed Nihar",
    "phone": "ad0e19163c4ff90313ce2b1457ea0687fbfbf0f344566e50bed07f60ae064",
    "photo": "rWHcAdajJoopFSYqnjNVXYebkngc0U",
    "aadhaar_linked_mobile_match": "Yes/No",
    "document_pdf": "YqnjNVXYebkngc0U"
  }
}
POST
/v2/ekyc/aadhaar/verify-otp
POST
API Key (header: x-api-key)
x-api-keystring
Required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.
API Key (header: client-id)
client-idstring
Required

The CLIENT_ID provided to you. This header parameter is required for authentication purposes.

The CLIENT_ID provided to you. This header parameter is required for authentication purposes.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
x-api-keystring
Required

API Key for authentication. The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

header
client-idstring
Required

API Key for authentication. The CLIENT_ID provided to you. This header parameter is required for authentication purposes.

Query Parameters

Responses

codeinteger
timestampinteger
transaction_idstring
sub_codestring
messagestring
dataobject

UIDAI regulations strictly prohibit sharing, publishing, or displaying share codes, XML files, or their contents with unauthorized parties. Non-compliance invokes penalties under The Aadhaar (Authentication) Regulation, 2016, The Aadhaar (Sharing of Information) Regulation, 2016, and The Aadhaar Act, 2016.

Customer consent must be mandatorily stored at your end before proceeding with verification.