Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

eAadhaar

post/v2/kyc/digilocker/eaadhaar

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

Request body

initial_decentro_transaction_idstring required

A unique ID assigned by Decentro when the session was initiated in Initiate Session API

consentboolean required

true/false based on the consent given by the customer. Mandatory as per regulation.

consent_purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation. (>20 characters)

reference_idstring required

Any unique ID assigned by you for this API request

generate_xmlboolean

If you want the xml file of eAadhaar from DigiLocker

generate_pdfboolean

If you want the PDF file of eAadhaar verified from DigiLocker

Response

200

OR
OR

Example response

{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "E-Aadhaar information received successfully from Digilocker",
  "data": {
    "aadhaarUid": "xxxxxxxx1234",
    "proofOfIdentity": {
      "dob": "DD-MM-YYYY",
      "gender": "M",
      "name": "MANISH GUPTA"
    },
    "proofOfAddress": {
      "country": "India",
      "district": "Bengaluru",
      "house": "XXX",
      "pincode": "XXXXXX",
      "state": "Karnataka",
      "vtc": "XXXXXXXXXXXXXXXXXXXXXXXX"
    },
    "image": "XXXXXXXXXXXXXXXXXXXXXXXXXXX"
  },
  "responseKey": "success_eaadhaar_download"
}