PAN-Udyam Check Status API

Endpoint Overview

POST /api/v1/pan-udyam-check/status

Description

The PAN-Udyam Check Status API enables you to retrieve the status and results of an asynchronous PAN-Udyam verification request. This endpoint is designed to work in conjunction with the initial PAN-Udyam verification request, allowing you to poll for results using the unique client_id generated during the initial request.

This API verifies whether a valid Udyam registration exists for a given PAN (Permanent Account Number) and provides migration status information. Udyam Registration is the government of India's initiative to register Micro, Small, and Medium Enterprises (MSMEs), replacing the earlier Udyog Aadhaar registration system.

Key Benefits

Asynchronous Processing: Check verification status without blocking your application workflow

MSME Verification: Instantly verify if a business entity is registered under the Udyam system

Migration Tracking: Determine if businesses have migrated from the old Udyog Aadhaar system

Compliance Assurance: Ensure business partners and vendors meet MSME registration requirements

Use Cases

Financial Services

E-commerce & Marketplaces

Corporate & Procurement

Lending Verification: Banks and NBFCs can verify MSME status before approving priority sector loans with preferential interest rates

Credit Assessment: Validate business legitimacy and MSME credentials during credit underwriting processes

Subsidy Validation: Verify eligibility for government-backed MSME lending schemes and subsidies

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

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

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for API authentication. Format: `Bearer YOUR_JWT_TOKEN`
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
client_id	string	Yes	Unique identifier returned from the initial PAN-Udyam verification request. Used to retrieve the status of the verification process. Format: `pan_udyam_check_async_{unique_id}`

Example Request

{
    "client_id": "pan_udyam_check_async_WsHoFrce"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Container object holding the verification results
data.client_id	string	The unique client identifier used for the verification request
data.pan_number	string	The PAN (Permanent Account Number) that was verified
data.status	string	Status of the verification process. Possible values: `success`, `pending`, `failed`
data.udyam_exists	boolean	Indicates whether a valid Udyam registration exists for the provided PAN
data.migration_status	string	Indicates if the business has migrated from Udyog Aadhaar to Udyam. Possible values: `migrated`, `not_migrated`
status_code	integer	HTTP status code of the response (200 for Success)
success	boolean	Indicates whether the API call was successful
message	string	Human-readable message describing the response status
message_code	string	Machine-readable code for the response status

Example Successful Response

{
    "data": {
        "client_id": "pan_udyam_check_async_WsHoFrc",
        "pan_number": "ABBCS1234D",
        "status": "success",
        "udyam_exists": true,
        "migration_status": "migrated"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid Client ID

Unauthorized

Processing

Internal Server Error

{
    "success": false,
    "status_code": 400,
    "message": "Invalid client_id provided",
    "message_code": "invalid_client_id"
}

Returned when the provided client_id is malformed or doesn't exist in the system.

Integration Best Practices

Security Recommendations

Token Management: Store JWT tokens securely using environment variables or secure vaults, never hardcode them in source code

HTTPS Only: Always use HTTPS endpoints to encrypt data in transit and prevent man-in-the-middle attacks

Token Rotation: Implement regular token refresh mechanisms and handle token expiration gracefully

Rate Limiting: Implement exponential backoff when polling for status to avoid hitting rate limits

Data Privacy: Ensure PAN numbers and verification results are stored securely and comply with data protection regulations

User Experience Guidelines

Polling Strategy: Implement intelligent polling with incremental delays (e.g., 2s, 5s, 10s) rather than constant rapid requests

Timeout Handling: Set reasonable timeout periods (e.g., 2-3 minutes) and inform users if verification takes longer than expected

Status Indicators: Display clear visual feedback showing verification is in progress using loading indicators or progress bars

Error Messages: Provide user-friendly error messages that explain what went wrong and suggest next steps

Retry Mechanism: Offer users the option to retry failed verifications with proper error handling

Code Samples

cURL

Python

Node.js

Related APIs

PAN-Udyam Verification API - Initiates the asynchronous PAN-Udyam verification process and returns a client_id for status tracking

Udyam Registration Details API - Retrieves comprehensive details of Udyam registration including business name, type, and registration date

PAN Verification API - Validates PAN number format and authenticity independently

GST Verification API - Verifies GST registration status which is often linked to MSME registrations

Compliance and Legal Considerations

Data Privacy: PAN is sensitive personal information under India's data protection regulations. Ensure you have proper consent and legitimate business purpose before collecting and processing PAN data

Purpose Limitation: Use this API only for legitimate business verification purposes such as KYC, vendor onboarding, or compliance checks

Data Retention: Implement appropriate data retention policies and delete verification results when no longer needed for business purposes

Regulatory Compliance: Ensure your use case complies with RBI guidelines for KYC, MSME Development Act provisions, and any sector-specific regulations

Audit Trail: Maintain logs of verification requests for compliance audits and dispute resolution

Terms of Service: Review and comply with Surepass API terms of service and acceptable use policies

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/pan-udyam-check/status' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "pan_udyam_check_async_WsHoFrce" }'

{ "data": { "client_id": "pan_udyam_check_async_WsHoFrc", "pan_number": "ABBCS1234D", "status": "success", "udyam_exists": true, "migration_status": "migrated" }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Status

PAN-Udyam Check Status API#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses