Get List of Documents

8 min

Introduction

Digilocker provides access to 1000+ documents. This API will give you the list of all such documents along with doctype, organization id, and different search parameters for each of the documents. For Example, if you want to pull PAN card, you would need org id, doctype, search parameters which you will get using this API.

How to call the API

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

API Input Guidelines

Sample Curl

Preproduction

Production

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/digilocker/listofdocuments' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    
}'

curl --location --request POST 'https://api.signzy.app/api/v3/digilocker/listofdocuments' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    
}'

Sample Response

{
    "result": [
        {
            "docType": "PVCER",
            "docDescription": "Provisional Certificate",
            "orgId": "005408",
            "orgName": "Aditya Birla Housing Finance LTD, Gujarat",
            "searchParameters": [
                {
                    "parameterName": "LoanAccountNO",  
                    "parameterExample": "LNCHA0HL-09170000001",
                    "isParameterValueAList": "No",
                    "parameterValueList": null
                },
                {
                    "parameterName": "FYear",
                    "parameterExample": "2018-2019,2019-2020,2020-2021,2021-2022,2022-2023",
                    "isParameterValueAList": "Yes",
                    "parameterValueList": "2018-2019,2019-2020,2020-2021,2021-2022,2022-2023"
                }
            ]
        },
        {
            "docType": "DGCER",
            "docDescription": "Degree/ Diploma Certificate",
            "orgId": "003902",
            "orgName": "Adamas University, West Bengal",
            "searchParameters": [
                {
                    "parameterName": "RROLL",
                    "parameterExample": "12345",
                    "isParameterValueAList": "No",
                    "parameterValueList": null
                },
                {
                    "parameterName": "REGNO",
                    "parameterExample": "XYZ-123",
                    "isParameterValueAList": "No",
                    "parameterValueList": null
                },
                {
                    "parameterName": "YEAR",
                    "parameterExample": "2017,2018,2019,2020,2022",
                    "isParameterValueAList": "Yes",
                    "parameterValueList": "2017,2018,2019,2020,2022"
                }
            ]
        },
......
    ]
}

Response Parameter

PARAMETERS	DESCRIPTION	TYPE	VALUE
docType	Type of Document	String	DGCER
docDescription	Description of Document	String	Degree/ Diploma Certificate
orgId	Organization Id document related to	String	009259
orgName	Organization name document related to	String	Career Point University, Hamirpur, Himachal Pradesh
orgName	Organization name document related to	String	Career Point University, Hamirpur, Himachal Pradesh
searchParameters	Parameters Available to search in digilocker	List of Objects
parameterName	Search parameter	String	REGNO
parameterExample	Search parameter	String	8/300001
isParameterValueAList	Search parameter	String	Yes/No
parameterValueList	Search parameter	String	Depends on type of parameter

Sample Error

{
    "error": {
        "statusCode": 500,
        "message": "Error fetching data",
        "status": 500,
        "reason": "Internal Server Error",
        "type": "Internal Server Error"
    }
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.statusCode	Request Status code from Signzy
error.reason	Reason for error
error.type	Type of the error

Error Codes

CODE	DESCRIPTION
500	Internal Server Error
401	Autorization Token is invalid

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].