E-Aadhaar

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
}
'

import requests

url = "https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar"

payload = {
    "consent": "<string>",
    "purpose": "<string>",
    "initial_deepvue_transaction_id": "<string>",
    "generate_pdf": False
}
headers = {
    "x-api-key": "<api-key>",
    "client-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'client-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    consent: '<string>',
    purpose: '<string>',
    initial_deepvue_transaction_id: '<string>',
    generate_pdf: false
  })
};

fetch('https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'consent' => '<string>',
    'purpose' => '<string>',
    'initial_deepvue_transaction_id' => '<string>',
    'generate_pdf' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "client-id: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar"

	payload := strings.NewReader("{\n  \"consent\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"initial_deepvue_transaction_id\": \"<string>\",\n  \"generate_pdf\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("client-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar")
  .header("x-api-key", "<api-key>")
  .header("client-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consent\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"initial_deepvue_transaction_id\": \"<string>\",\n  \"generate_pdf\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["client-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"consent\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"initial_deepvue_transaction_id\": \"<string>\",\n  \"generate_pdf\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

POST

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
}
'

import requests

url = "https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar"

payload = {
    "consent": "<string>",
    "purpose": "<string>",
    "initial_deepvue_transaction_id": "<string>",
    "generate_pdf": False
}
headers = {
    "x-api-key": "<api-key>",
    "client-id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'client-id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    consent: '<string>',
    purpose: '<string>',
    initial_deepvue_transaction_id: '<string>',
    generate_pdf: false
  })
};

fetch('https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'consent' => '<string>',
    'purpose' => '<string>',
    'initial_deepvue_transaction_id' => '<string>',
    'generate_pdf' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "client-id: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar"

	payload := strings.NewReader("{\n  \"consent\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"initial_deepvue_transaction_id\": \"<string>\",\n  \"generate_pdf\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("client-id", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar")
  .header("x-api-key", "<api-key>")
  .header("client-id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consent\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"initial_deepvue_transaction_id\": \"<string>\",\n  \"generate_pdf\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.deepvue.tech/v1/kyc/digilocker/eaadhaar")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["client-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"consent\": \"<string>\",\n  \"purpose\": \"<string>\",\n  \"initial_deepvue_transaction_id\": \"<string>\",\n  \"generate_pdf\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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

code

integer

default:200

timestamp

integer

transaction_id

string

sub_code

string

message

string

data

Data · object

Show child attributes

Getting Started

Auth

APIs

Authorizations

Body

Response