v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

SSO DigiLocker File Data API

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

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

file_urnstring required

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.

Response

200

decentroTxnIdstring

statusstring

responseCodestring

messagestring

responseKeystring

Example response

{
  "decentroTxnId": "DXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "File data fetched successfully as JSON from MeriPehchaan",
  "data": {
    "documentIssuer": "Income Tax Department",
    "documentName": "PAN Card",
    "documentType": "PANCR",
    "idNumber": "XXXXXXXXXX",
    "userName": "MANISH GUPTA",
    "userDateOfBirth": "DD-MM-YYYY",
    "userGender": "MALE",
    "documentVerifiedOn": "DD-MM-YYYY 18:54:22",
    "documentStatus": "Active"
  },
  "responseKey": "success_file_data"
}