Issuers List

Endpoint Overview

GET /api/v1/digilocker/pull/issuers

Description

This API endpoint retrieves a comprehensive list of all issuers available in DigiLocker. Issuers are government departments, educational institutions, and other organizations that issue official documents through DigiLocker. This endpoint allows developers to access the complete catalog of document issuers, enabling applications to present users with accurate options when requesting documents from specific sources.

Key Benefits

Access the complete list of authorized DigiLocker document issuers in one request

Stay updated with the latest available document sources without manual tracking

Improve user experience by providing accurate issuer selection options

Streamline document retrieval workflows with proper issuer identification

Use Cases

Financial Services

Education

Government Services

Build KYC verification flows that allow users to select from official document issuers

Create document collection interfaces for loan applications with accurate issuer information

Implement automated verification systems that validate documents against authorized issuers

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	JWT Bearer token for authentication. Format: `Bearer <your_token>`
Content-Type	Yes	Must be set to `application/json`

Request Body

This endpoint does not require a request body as it's a GET request to retrieve the list of all issuers.

Process Response

Response Parameters

Parameter	Type	Description
data.issuers	Array	List of issuer objects
data.issuers[].orgName	String	Name of the issuer
data.issuers[].description	String	Description of the issuer
data.issuers[].issuerId	String	Unique issuer ID
data.issuers[].orgId	String	Organization ID or category (e.g., Education, Central Government, etc.)
success	Boolean	Indicates if the API request was successful
status_code	Number	HTTP status code of the response
message	String	Response message indicating success or failure
message_code	String	Code representing the response message
data	Object	Contains a list of issuer details

Example Successful Response

{
  "data": {
    "issuers": [
      {
        "orgName": "CBSE",
        "description": "Central Board of Secondary Education",
        "issuerId": "001122",
        "orgId": "Education"
      },
      {
        "orgName": "Income Tax Department",
        "description": "Department of Revenue, Ministry of Finance",
        "issuerId": "001123",
        "orgId": "Central Government"
      }
    ]
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Authentication Error

Server Error

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

This error occurs when the JWT token is missing, invalid, or expired. Ensure you're using the correct token for the environment.

Integration Best Practices

Security Recommendations

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

Implement token refresh mechanisms to handle token expiration gracefully

Use HTTPS for all API communications to ensure data security

Implement proper error handling to avoid exposing sensitive information

User Experience Guidelines

Cache the issuers list to reduce API calls and improve application performance

Implement search and filtering functionality to help users find specific issuers

Group issuers by category to improve navigation in user interfaces

Display issuer details like description and available document types to help users make informed selections

Code Samples

cURL

Python

Node.js

Related APIs

DigiLocker Document Pull API - Retrieves documents from specified issuers

DigiLocker User Profile API - Gets user profile information from DigiLocker

DigiLocker Document Types API - Lists available document types from specific issuers

Compliance and Legal Considerations

When using the Issuers List API, ensure you comply with DigiLocker's terms of service and data usage policies. The documents retrieved through DigiLocker must be used in accordance with India's Information Technology Act, 2000 and the Aadhaar Act, 2016. Proper user consent must be obtained before retrieving any documents from the issuers listed in this API response.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Issuers List

Issuers List#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Issuers List

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples