Pan To UAN

Endpoint Overview

POST /api/v1/pan/pan-to-uan

Description

This API endpoint allows you to retrieve a Universal Account Number (UAN) by providing a Permanent Account Number (PAN). The service performs a lookup in the EPFO (Employees' Provident Fund Organisation) database to fetch the associated UAN for the given PAN, enabling seamless verification and integration with employment and financial systems.

Key Benefits

Instant UAN retrieval using only PAN information

Simplified employee onboarding and verification processes

Reduced manual data entry and potential errors

Compliance with EPFO verification requirements

Use Cases

HR & Payroll

Financial Services

Business Operations

Streamline employee onboarding by automatically retrieving UAN details

Verify employment history and PF contributions during recruitment

Automate payroll systems with accurate UAN information

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 (JWT format)
Content-Type	Yes	Application/json

Request Body

Parameter	Type	Required	Description
pan_number	String	Yes	The PAN (Permanent Account Number) for which UAN needs to be retrieved

Example Request

{
    "pan_number": "xxxx1234xxxx"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the retrieved information
data.client_id	String	Unique identifier for the API request
data.pan_number	String	The PAN number provided in the request
data.uan_number	String	The Universal Account Number associated with the PAN
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Example Successful Response

{
    "data": {
        "client_id": "pan_to_uan_hoadKOGjFSjwnS",
        "pan_number": "XXXXX1234X",
        "uan_number": "123456789"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid PAN Format

UAN Not Found

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Invalid PAN format",
    "message_code": "invalid_pan_format"
}

The provided PAN number does not match the required format.

Integration Best Practices

Security Recommendations

Store API keys securely and never expose them in client-side code

Implement proper error handling to prevent leaking sensitive information

Use HTTPS for all API communications to ensure data encryption

Implement rate limiting on your end to prevent abuse of the API

User Experience Guidelines

Validate PAN format client-side before making API calls

Implement appropriate loading indicators during API requests

Display clear error messages to users when UAN retrieval fails

Cache results where appropriate to improve response times

Code Samples

cURL

Python

Node.js

Related APIs

PAN Verification API - Validates PAN details against government records

UAN Verification API - Verifies UAN details and retrieves associated information

Employee PF Details API - Retrieves provident fund contribution details using UAN

Compliance and Legal Considerations

This API accesses EPFO data and should be used in compliance with applicable data protection regulations. Ensure you have appropriate consent from individuals before retrieving their UAN information. The data should be used only for legitimate business purposes as permitted by law.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/pan/pan-to-uan' \ --header 'Authorization: Bearer TOKEN' \ --header 'Content-Type: application/json' \ --data-raw '{ "pan_number": "xxxx1234xxxx" }'

{ "data": { "client_id": "pan_to_uan_hoadKOGjFSjwnS", "pan_number": "XXXXX1234X", "uan_number": "123456789" }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Pan To UAN

Pan To UAN#

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

Pan To UAN

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples