Skip to main content
POST
/
api
/
client
/
profile-creation-with-digilocker
Initiate DigiLocker
curl --request POST \
  --url https://bgv.konnectnxt.com/api/api/client/profile-creation-with-digilocker \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "SAM",
  "email": "sam@gmail.com",
  "mobile": "9090909012",
  "documents_requested": [
    "ADHAR",
    "PANCR"
  ],
  "callback_url": "https://webhook.site/9c4c8d1a-8c2b-4f9e-9b2f-2c12fbd1f9f3",
  "extra_fields": {
    "panno": "AABCI6363G",
    "PANFullName": "SAM"
  }
}
'
{
  "status": "success",
  "code": 200,
  "message": "DigiLocker session initiated successfully",
  "data": {
    "consent_url": "https://testbgv.konnectnxt.com/api/digilocker/consent-form?case=36af8453-51e9-43e1-aace-3e8371ef2118",
    "case_id": "36af8453-51e9-43e1-aace-3e8371ef2118"
  },
  "credits_used": 50,
  "credits_remaining": 10000
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
Example:

"SAM"

​
email
string<email>
required
Example:

"sam@gmail.com"

​
mobile
string
required
Example:

"9090909012"

​
documents_requested
enum<string>[]
required
Minimum array length: 1
Available options:
ADHAR,
PANCR
Example:
["ADHAR", "PANCR"]
​
callback_url
string<uri>

Webhook URL to receive DigiLocker updates (optional)

Example:

"https://webhook.site/9c4c8d1a-8c2b-4f9e-9b2f-2c12fbd1f9f3"

​
extra_fields
object

Optional document-specific metadata

Response

DigiLocker request successfully initiated

​
status
string
required
Example:

"success"

​
code
integer
required
Example:

200

​
message
string
required
Example:

"DigiLocker session initiated successfully"

​
data
object
required
​
credits_used
integer
required
Example:

50

​
credits_remaining
number
required
Example:

10000