Get Details API

4 min

Introduction

This API can be used to get the details about the files that are uploaded to digilocker.

How to call the API

You will need to login before sending request. You are required to pass the access token received from the login call, as authorization header in the Get Details API request.

API Input Guidelines

You can get requestId from the Create URL API.

Sample CURL

Preproduction

Production

curl --location --request POST '<https://preproduction.signzy.tech/api/v2/patrons/<Patron> ID>/digilockers' \
--header 'Connection: keep-alive' \
--header 'Authorization: <Access Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "task": "getDetails",
    "essentials": {
        "requestId": "<Request ID>"
    }
}'

curl --location --request POST '<https://signzy.tech/api/v2/patrons/<Patron> ID>/digilockers' \
--header 'Connection: keep-alive' \
--header 'Authorization: <Access Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "task": "getDetails",
    "essentials": {
        "requestId": "<Request ID>"
    }
}'

Sample API Response

{
    "essentials": {
        "requestId": "<Unique File ID>"
    },
    "id": "<Unique User ID>",
    "patronId": "<Patron ID>",
    "task": "getDetails",
    "result": {
        "userDetails": {
            "digilockerid": "<Unique Digilocker ID of user>",
            "name": "Ram Singh",
            "dob": "D.O.B",
            "gender": "M",
            "eaadhaar": "Y"
        },
        "files": [
            {
                "name": "Aadhaar Card",
                "type": "file",
                "size": "",
                "date": "22/09/2021",
                "parent": "",
                "mime": [
                    "application/pdf",
                    "application/xml"
                ],
                "doctype": "ADHAR",
                "description": "Aadhaar Card",
                "issuerid": "in.gov.uidai",
                "issuer": "Aadhaar, Unique Identification Authority of India",
                "id": "in.gov.uidai-ADHAR-6b931b93940cbc7a25a185229dfbxxxx"
            },
            {
                "name": "Class X Marksheet",
                "type": "file",
                "size": "",
                "date": "11/05/2020",
                "parent": "",
                "mime": [
                    "application/json",
                    "application/xml",
                    "application/pdf"
                ],
                "doctype": "SSCER",
                "description": "Class X Marksheet",
                "issuerid": "in.gov.cbse",
                "issuer": "Central Board of Secondary Education",
                "id": "in.gov.cbse-SSCER-5147103xxx"
            },
            {
                "name": "Class XII Marksheet",
                "type": "file",
                "size": "",
                "date": "11/05/2020",
                "parent": "",
                "mime": [
                    "application/json",
                    "application/xml",
                    "application/pdf"
                ],
                "doctype": "HSCER",
                "description": "Class XII Marksheet",
                "issuerid": "in.gov.cbse",
                "issuer": "Central Board of Secondary Education",
                "id": "in.gov.cbse-HSCER-764279xxxxx"
            },
            {
                "name": "Class XII Migration Certificate",
                "type": "file",
                "size": "",
                "date": "11/05/2020",
                "parent": "",
                "mime": [
                    "application/pdf"
                ],
                "doctype": "HSMGR",
                "description": "Class XII Migration Certificate",
                "issuerid": "in.gov.cbse",
                "issuer": "Central Board of Secondary Education",
                "id": "in.gov.cbse-HSMGR-764179xxxxx"
            },
            {
                "name": "Class XII Passing Certificate",
                "type": "file",
                "size": "",
                "date": "11/05/2020",
                "parent": "",
                "mime": [
                    "application/pdf"
                ],
                "doctype": "HPCER",
                "description": "Class XII Passing Certificate",
                "issuerid": "in.gov.cbse",
                "issuer": "Central Board of Secondary Education",
                "id": "in.gov.cbse-HPCER-7641792xxxx"
            },
            {
                "name": "Driving License",
                "type": "file",
                "size": "",
                "date": "22/03/2020",
                "parent": "",
                "mime": [
                    "application/json",
                    "application/xml",
                    "application/pdf"
                ],
                "doctype": "DRVLC",
                "description": "Driving License",
                "issuerid": "in.gov.transport",
                "issuer": "Ministry of Road Transport and Highways",
                "id": "in.gov.transport-DRVLC-JH092020000xxxx"
            },
            {
                "name": "PAN Verification Record",
                "type": "file",
                "size": "",
                "date": "02/11/2019",
                "parent": "",
                "mime": [
                    "application/json",
                    "application/xml",
                    "application/pdf"
                ],
                "doctype": "PANCR",
                "description": "PAN Verification Record",
                "issuerid": "in.gov.pan",
                "issuer": "Income Tax Department",
                "id": "in.gov.pan-PANCR-<PAN Number>"
            }
        ]
    }
}

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].