Skip to main content
POST
/
v1
/
kyc
/
digilocker
/
initiate-session
Initiate Session
curl --request POST \
  --url https://production.deepvue.tech/v1/kyc/digilocker/initiate-session \
  --header 'Content-Type: application/json' \
  --header 'client-id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "consent": "<string>",
  "purpose": "<string>",
  "redirect_url": "<string>",
  "doc_types": [
    "aadhaar"
  ]
}
'
{
  "timestamp": 1738305237960,
  "transaction_id": "0c8c7833678e412f9fec77dbe0494562",
  "data": {
    "authorization_url": "https://production.deepvue.tech/v1/kyc/digilocker/digilocker-redirect?state=0c8c7833678e412f9fec77dbe0494562"
  },
  "code": 201
}

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
​
consent
string
required

The consent parameter indicates whether the user has given consent for the session initiation in the Digilocker service.

​
purpose
string
required

The purpose parameter specifies the reason for initiating the session in the Digilocker service.

​
redirect_url
string

URL where the user needs to be redirected once the consent is approved.

​
doc_types
enum<string>[]

List of ID Documents. Allowed values are 'aadhaar', 'pan', 'dl'. Only the specified document types will be displayed on the consent screen page for the user. Default value: ['aadhaar','pan','dl']

Available options:
aadhaar,
pan,
dl

Response

Successful Response