Skip to main content
POST
/
v1
/
kyc
/
digilocker
/
eaadhaar
E Aadhaar
curl --request POST \
  --url https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar \
  --header 'Content-Type: application/json' \
  --header 'client-id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "consent": "<string>",
  "purpose": "<string>",
  "initial_deepvue_transaction_id": "<string>",
  "generate_pdf": false
}
'
{
  "code": 200,
  "timestamp": 1731338938745,
  "transaction_id": "string",
  "sub_code": "string",
  "message": "string",
  "data": {
    "masked_uid": "string",
    "proof_of_identity": {
      "dob": "string",
      "gender": "string",
      "name": "string"
    },
    "proof_of_address": {
      "care_of": "string",
      "district": "string",
      "house": "string",
      "locality": "string",
      "street": "string",
      "vtc": "string",
      "pincode": "string",
      "state": "string",
      "country": "string"
    },
    "photo": "base64-string",
    "document_pdf": "base64-string"
  }
}

Authorizations

x-api-key
string
header
required

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

client-id
string
header
required

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

Body

application/json

Pass Y stating the consent has been duly taken from the user.

purpose
string
required

Mention the purpose.

initial_deepvue_transaction_id
string
required

transaction_id received from the Initiate Session API Endpoint.

generate_pdf
boolean
default:false

Set this true or false based on whether you wish to generate a PDF.

Response

Successful Response

timestamp
integer
required
transaction_id
string
required
sub_code
string
required
message
string
required
code
integer
default:200
data
DigilockerEaadhaarData · object