API Reference

Get Issued Files

FieldTypeDescription
statuscodeIntegerHTTP-like custom response code indicating success (200 = OK).
statusBooleanTrue if transaction was successful
messageStringList of issues files fetched successfully.
nameStringThe document’s display name (e.g., “Aadhaar Card”, “Class X Marksheet”).
typeStringIndicates the type of record. Usually "file" for DigiLocker documents.
sizeStringFile size (if available). Sometimes blank if not provided by DigiLocker.
dateString(DD-MM-YYYY)The date when the document was issued or added to DigiLocker.
parentStringRepresents any parent folder or grouping for the file (blank if none).
mimeArray of stringsLists the supported file formats (e.g., application/pdf, application/xml, application/json).
uriStringUnique document identifier (Uniform Resource Identifier) assigned by DigiLocker. Used to fetch or download the file.
doctypeStringDocument type code as defined by DigiLocker (e.g., ADHAR, SSCER, PANCR). Each corresponds to a specific document category.
descriptionStringShort textual description of the document. Often matches the name field.
issueridStringUnique identifier of the issuing organization within DigiLocker (e.g., in.gov.uidai, in.gov.cbse).
issuerStringFull name of the issuing authority or department that issued the document (e.g., “Income Tax Department”).
Language
Click Try It! to start a request and see the response here!