Pull Documents

9 min

Introduction

You can use this API to pull any of the documents by passing the value - docType, name, panNumber. Supported docType is only PANCR.

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/pullDocuments' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "...requestId...",
    "docType": "...docType...",
    "name": "...name...",
    "panNumber": "...panNumber..."
}'

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

Input Parameters

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
requestId	RequestId token	String	COMPULSORY
docType	Name of the DocType to be called	String	COMPULSORY
name	Name of the person	String	COMPULSORY
panNumber	Pan Number of the person	String	COMPULSORY

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

{
    "message": "No API key found in request"
}

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