Digilocker 2.0 Get List of Documents
Introduction
The Get List of Documents API provides an extensive directory of documents associated with Digilocker. Additionally, it furnishes essential details, including Document issuing Organization Name and organization ID along with specific search parameters for each document type. This functionality streamlines the process of identifying and accessing documents from diverse sources, enhancing overall accessibility and usability.
API details
Endpoint
POST https://api.signzy.app/api/v3/digilocker-v2/listofdocumentsPOST https://api-preproduction.signzy.app/api/v3/digilocker-v2/listofdocumentsRequest headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Request body parameter
You can make this API call with just an empty body.
{}Code samples
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api-preproduction.signzy.app/api/v3/digilocker-v2/listofdocuments"
method := "POST"
payload := strings.NewReader(`{}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "<Your Access token>")
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}Response body parameters
Parameter | Data Type | Description |
|---|---|---|
result | Array of objects | Contains the details of all the documents present in Digilocker. |
result.docType | String | The type of document. |
result.docDescription | String | A description of the document. |
result.orgId | String | The ID of the organization that issued the document. |
result.orgName | String | The name of the organization that issued the document. |
result.searchParameters | Array of objects | A list of search parameters that can be used to search for the document. These Parameters vary with each docType and each docType will contain one or more than one search Parameter. |
result.searchParameters.parameterName | String | Indicates the name of the parameter. |
result.searchParameters.parameterExample | String | Provides an example of a valid value for the parameter. |
result.searchParameters.isParameterValueAList | String | Indicates whether the parameter can be used to search for a list of values. Returns Yes if you can input a list of values. |
result.searchParameters.parameterValueList | String | The field is used to provide a list of values for the specified parameter. |
// If the customer denies consent for accessing data on the digilocker screen
{
"error": {
"statusCode": 400,
"name": "error",
"message": "User denied the consent, please try again",
"status": 400,
"type": "Bad Request",
"statusCode": 400
}
}
// If the customer clicks on “Return to Signzy” anytime during the digilocker journey
{
"error": {
"statusCode": 400,
"name": "error",
"message": "User cancelled the journey, please try again",
"status": 400,
"type": "Bad Request",
"statusCode": 400
}
}Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!