V1Initiate Session

Aadhaar eKYC V1 — Start Session

Start an Offline Aadhaar eKYC session with captcha verification. Returns a session ID and captcha image to begin the consent flow.

curl -X GET "https://production.deepvue.tech/v1/ekyc/aadhaar/connect?consent=example_string&purpose=example_string" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "client-id: YOUR_API_KEY"
{
  "code": 200,
  "timestamp": 1738303175394,
  "transaction_id": "f5d8e48f477f4116967a6be4d97a7769",
  "data": {
    "session_id": "17568923be1441a9b05c7af693e92aa5",
    "captcha": "/9j/4AAQSkZJRgABAQAAAQABAAD/..."
  }
}
GET
/v1/ekyc/aadhaar/connect
GET
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
dataobject

Per UIDAI regulations, sharing and storage of Aadhaar numbers is prohibited. Service providers must not distribute, publish, or display the share code, XML file, or its contents with anyone else. Non-compliance may result in actions under The Aadhaar (Authentication) Regulation, 2016, The Aadhaar (Sharing of Information) Regulation, 2016, and The Aadhaar Act, 2016.

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