Pull Documents V2

9 min

Introduction

You can use this API to pull any of the documents by passing the value - Org ID, Doctype, search parameters, etc. To get the values of those parameters, you need to call Get List of Documents API first.

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

Need to pass follow information. 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/pullDocumentsV2' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "...request id...",
    "docType": "...doc type...",
    "orgid": "...org id...",
    "consent": "Y",
    "searchParameters": {
        "": "......",
        "": "......"
    }
}'

curl --location --request POST 'https://api.signzy.app/api/v3/digilocker/pullDocumentsV2' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "...request id...",
    "docType": "...doc type...",
    "orgid": "...org id...",
    "consent": "Y",
    "searchParameters": {
        "": "......",
        "": "......"
    }
}'

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
requestId	RequestId token	String	COMPULSORY
docType	Name of the DocType to be called	String	COMPULSORY
orgid	Id of the issuing agency	String	COMPULSORY
consent	The consent indicator from the user for sharing his Aadhaar details with the issuer for pulling the document into his/her DigiLocker. Client must capture the consent from the user. The possible values are “Y” and “N”. The client application must display following consent text to the user and capture user’s consent: I provide my consent to share my Aadhaar Number, Date of Birth and Name from my Aadhaar eKYC information with the {{Issuer Name}} for the purpose of fetching my {{Certificate Name}} into DigiLocker. The {{Issuer Name}} in above text will be replaced by the orgName and the {{Certificate Name}} will be replaced by the docDescription returned in Get List of Documents API.	String	COMPULSORY
searchParameters	Parameters required for fetching a document as listed in parameterName field in searchParameter Array of Get List of Documents API	Object	COMPULSORY (conditional)

Sample Response

{
    "result": {
        "fileId" : "...fileId...",
        "pdf": "...direct url to download pdf...",
        "xml": "...direct url to download xml..." 
    }                         
 }

Response Parameter

PARAMETERS	DESCRIPTION	TYPE	VALUE
fileId	fileId of the document	String
pdf	PDF format of document	String	URL
xml	XML format of document	String	URL

Sample Error

{
    "error": {
        "reason": "BAD_REQUEST",
        "status": 400,
        "message": "INVALID requestId",
        "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

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