v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB

DigiLocker

Get DigiLocker user details

Fetches user details from DigiLocker using a reference_key. Requires X-API-KEY and X-Client-ID headers.

post/verify/digilocker/user_details

Request body

reference_keystring required

Reference key obtained from /digilocker/get_reference.

Example request

{
  "reference_key": "1700000000000_abcdef123456"
}

Response

DigiLocker user details

statusstring required

Overall API response status

chargeblestring

Indicates if the operation is chargeable ('true'|'false')

user_consentstring

Indicates whether user consent was recorded ('true'|'false')

Example response

{
  "status": "success",
  "user": {
    "digilockerid": "11111111-2222-3333-4444-555555555555",
    "name": "Amit Verma",
    "dob": "1990-05-21",
    "gender": "M",
    "eaadhaar": "Y",
    "reference_key": "1700000000000_abcdef123456",
    "mobile": "9123456789",
    "picture": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
    "email": "amit.verma@example.com"
  },
  "chargeble": "true",
  "user_consent": "true"
}