Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

SSO DigiLocker eAadhaar API

post/v2/kyc/sso/digilocker/{initial_decentro_txn_id}/eaadhaar

Path parameters

initial_decentro_txn_idstring required

decentroTxnId value received in the Initiate Session API

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

consentboolean required

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

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

true/false

generate_pdfboolean

true/false

Response

200

OR
OR
OR

Example response

{
  "decentroTxnId": "DXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "E-Aadhaar information received successfully from MeriPehchaan",
  "data": {
    "aadhaarUid": "xxxxxxxx0000",
    "proofOfIdentity": {
      "dob": "DD-MM-YYYY",
      "gender": "M",
      "name": "Manish Gupta"
    },
    "proofOfAddress": {
      "careOf": "XXXXXXXXXXXXXX",
      "country": "India",
      "district": "XXXXXXXXXX",
      "house": "XXX",
      "landmark": "XXXXXXXXXXXXXXXXXX",
      "pincode": "XXXXXX",
      "state": "XXXXXXXXXXXXXXXXXXXX",
      "vtc": "XXXXXXXXXXXXXXXXXXXX"
    },
    "image": "<Base64 of Image>",
    "pdf": "<Base64 of PDF>",
    "xml": "<Base64 of XML>"
  },
  "responseKey": "success_eaadhaar_download"
}