Get Details

9 min

Introduction

Get Details API call gives you the details of all the Issued documents in the end user’s Digilocker account. For example, if an end user has an Aadhaar card and PAN card in his/her Digilocker account, Get Details API will give you the list of these 2 documents alongwith the File ID.

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

You need to make sure that your input parameter requestId is authorized before you call this API.

Sample Curl

Preproduction

Production

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

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

Input Parameters

FIELD	DESCRIPTION	STRING	REQUIRED
requestId	Contains Properties and parameters we want to take	String	Required

Sample Response

{
    "result": {
        "userDetails": {
            "digilockerid": "",
            "name": "",
            "dob": "",
            "gender": "",
            "eaadhaar": ""
        },
        "files": [
            {
                "name": "",
                "type": "",
                "size": "",
                "date": "",
                "parent": "",
                "mime": [
                    "",
                    ""
                ],
                "doctype": "",
                "description": "",
                "issuerid": "",
                "issuer": "",
                "id": ""
            }
        ]
    }
}

Response Parameter

FIELD	DESCRIPTION	TYPE
result	Contains content of userDetails and files	Object
userDetails	Contains content of userDetails	Object
digilockerid	...digilockerid...	String
name	...name...	String
dob	...dob...	String
gender	...M/F/T...	String
eaadhaar	...Y or N as per availability...	String
files	...array of objects of files ...	Array
name	Aadhaar Card	String
type	file	String
size		String
date	...date...	String
parent		String
mime	["application/pdf", "application/xml", //Optional "application/json" //If available]	Array
doctype	...5 letter DOC key...	String
description	...Description...	String
issuerid	...issuer id...	String
issuer	...issuer name...	String
id	"...unique file ID..." // required for downloading the file	String

Sample Error

{
    "error": {
        "reason": "AUTH_FAIL",
        "status": 400,
        "message": "This requestId is not authorized to perform this action.",
        "type": "Bad Request",
        "statusCode": 400,
        "name": "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
400	Invalid inputs
401	Authorization token is invalid
409	If Upstream service not reachable

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