Documents List

Endpoint Overview

GET /api/v1/digilocker/pull/docs/{org_id}

Description

This API endpoint retrieves a list of all documents available in a user's DigiLocker account for a specific organization. It allows developers to access and display the documents that a user has stored in their DigiLocker, enabling seamless integration of DigiLocker's document repository with your application.

Key Benefits

Retrieve a comprehensive list of all documents from a user's DigiLocker account

Filter documents by organization ID for targeted access

Integrate DigiLocker's secure document storage with your application

Enable users to access their official documents without leaving your platform

Use Cases

Financial Services

Government Services

Education

KYC verification using government-issued documents stored in DigiLocker

Loan application processing with instant document verification

Account opening with pre-verified identity documents

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication. Format: `Bearer {your_jwt_token}`
Content-Type	Yes	Application/json

Path Parameters

Parameter	Type	Required	Description
org_id	String	Yes	The organization ID for which to retrieve documents

Request Body

This endpoint does not require a request body.

Process Response

Response Parameters

Parameter	Type	Description
success	Boolean	Indicates if the request was successful
data	Object	Contains the document list data
data.docs	Array	List of documents available in the user's DigiLocker
data.docs[].name	String	Name of the document
data.docs[].documents	String	Unique identifier for the document
data.docs[].issuerid	String	Organization that issued the document
data.docs[].description	String	Description of the document

Example Successful Response

{
  "success": true,
  "data": {
    "docs": [
      {
        "name": "Income Certificate",
        "documents": "",
        "issuerid": "00012",
        "description": "Income Certificate issued by Revenue Department"
      },
      {
        "name": "Aadhaar Card",
        "documents": "",
        "issuerid": "00013",
        "description": "Aadhaar Card issued by UIDAI"
      }
    ]
  }
}

Possible Error Responses

Authentication Error

Resource Not Found

Server Error

{
  "success": false,
  "error": {
    "code": 401,
    "message": "Invalid or expired authentication token"
  }
}

This error occurs when the JWT token is invalid, expired, or not provided.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper token refresh mechanisms to handle token expiration

Use HTTPS for all API communications to ensure data security

Implement proper error handling to avoid exposing sensitive information

User Experience Guidelines

Provide clear instructions to users about connecting their DigiLocker account

Display document lists in an organized manner with relevant filtering options

Implement proper loading states while fetching documents

Provide clear error messages when document retrieval fails

Code Samples

cURL

Python

Node.js

Related APIs

DigiLocker Document Pull API: Retrieves specific document content from DigiLocker

DigiLocker Authentication API: Authenticates users with DigiLocker

DigiLocker Document Verification API: Verifies the authenticity of documents

Compliance and Legal Considerations

When accessing DigiLocker documents, ensure you have explicit user consent as per the DigiLocker Terms of Service. The use of DigiLocker data is subject to compliance with the Information Technology Act, 2000 and related privacy laws. Ensure proper data handling practices to maintain user privacy and data security.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Documents List

Documents List#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Path Parameters#

Request Body#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Documents List

Description

Use Cases

Technical Implementation

Request Headers

Path Parameters

Request Body

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples