Get Files

9 min

Introduction

Get Files API takes in requestId, fileId you get from the response of Get Details API as an input and returns the details about the file you request for.

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/getFiles' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId" : "<request ID>",
    "fileIds" : [
        "<file ID>",
        "<file ID>"
    ]
}'

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

Input Parameters

FIELD	DESCRIPTION	TYPE	REQUIRED
requestId	...requestId...	String	Required
fileIds	["...fileIds..."] // array of file IDs found in Get Documents API	Array	Required

Sample Response

{
  "result": {
    "files": [
      {
        "name": "PAN Verification Record",
        "type": "file",
        "size": "",
        "date": "",
        "parent": "",
        "mime": ["", "", ""],
        "doctype": "PANCR",
        "description": "PAN Verification Record",
        "issuerid": "in.gov.pan",
        "issuer": "Income Tax Department",
        "id": "",
        "file": {
          "pdf": "",
          "xml": ""
        }
      }
    ]
  }
}

Response Parameter

FIELD	DESCRIPTION	TYPE
result	Contains content of response	Object
files	Array of object 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
file	object of downloadable file	Object
pdf	...direct url to download pdf...	String
xml	"...direct url to download xml..." // where available	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].