EPFO Passbook Status

Endpoint Overview

POST /api/v1/epfo-passbook-advanced/status

Description

This API retrieves detailed EPFO (Employees' Provident Fund Organisation) passbook information for a member using the client ID obtained from the EPFO Passbook Init API. The response includes comprehensive employment history, contribution details, and personal information associated with the member's Universal Account Number (UAN).

Key Benefits

Access complete EPFO passbook history across multiple employers

View detailed monthly contribution breakdowns (employee, employer, and pension shares)

Track transaction descriptions and approval dates for each contribution

Retrieve personal information associated with the UAN

Use Cases

Financial Services

HR & Recruitment

Personal Finance

Income verification for loan and credit applications

Employment history verification for financial products

Retirement planning and pension fund analysis

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)
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
client_id	String	Yes	Unique client identifier obtained from the EPFO Passbook Init API

Example Request

{
    "client_id": "epfo_passbook_advanced_wfrrLtgaxcsiRQiyuqly"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains all the EPFO passbook information
data.client_id	String	Unique client identifier
data.uan	String	Universal Account Number (UAN)
data.full_name	String	Full name of the EPFO member
data.mobile	String	Mobile number of the member
data.father_name	String	Father's name of the member
data.dob	String	Date of birth in YYYY-MM-DD format
data.details	Array	List of employment details across different establishments
status_code	Integer	HTTP status code
success	Boolean	Indicates if the request was successful
message	String	Response message
message_code	String	Code representing the response message

Employment Details Object

Parameter	Type	Description
member_id	String	Member ID assigned by EPFO for a specific employment
est_name	String	Establishment/employer name
doj_epf	String	Date of joining EPF for this employment in YYYY-MM-DD format
passbook_details	Array	List of monthly contribution transactions

Passbook Details Object

Parameter	Type	Description
employee_share	String	Employee's contribution amount
employer_share	String	Employer's contribution amount
pension_share	String	Pension fund contribution amount
approved_on	String	Date when the transaction was approved in YYYY-MM-DD format
year	String	Year of the contribution
month	String	Month of the contribution
description	String	Description of the transaction (e.g., monthly contribution, interest, transfer)

Example Successful Response

{
    "data": {
        "client_id": "epfo_passbook_advanced_ljNlWPBmnrhypGKdbygs",
        "uan": "100584578123",
        "full_name": "MOHIT YADAV",
        "mobile": "9123186987",
        "father_name": "Bhagwati Prasad",
        "dob": "1994-02-11",
        "details": [
            {
                "member_id": "DSNHP10383380000010123",
                "est_name": "M.B.A CONSULTING INDIA PRIVATE LIMITED",
                "doj_epf": "2015-10-12",
                "passbook_details": [
                    {
                        "employee_share": "297",
                        "employer_share": "90",
                        "pension_share": "207",
                        "approved_on": "2017-11-15",
                        "year": "2017",
                        "month": "11",
                        "description": "Cont. For Due-Month 112017"
                    },
                    {
                        "employee_share": "8",
                        "employer_share": "3",
                        "pension_share": "0",
                        "approved_on": "2018-10-10",
                        "year": "2017",
                        "month": "04",
                        "description": "Int. Updated upto 31/03/2018"
                    }
                ]
            },
            {
                "member_id": "THTHA15499610000491234",
                "est_name": "INNOVSOURCE SERVICES PRIVATE LIMITED",
                "doj_epf": "2023-11-09",
                "passbook_details": [
                    {
                        "employee_share": "1800",
                        "employer_share": "550",
                        "pension_share": "1250",
                        "approved_on": "2023-12-14",
                        "year": "2023",
                        "month": "12",
                        "description": "Cont. For Due-Month 122023"
                    }
                ]
            }
        ]
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Session Expired

Invalid Client ID

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Session expired",
    "message_code": "session_expired"
}

The session is only active for 10 minutes after initialization. If this error occurs, you need to reinitiate the process using the EPFO Passbook Init API.

Integration Best Practices

Security Recommendations

Store the client_id securely and do not expose it in client-side code

Implement proper error handling for session expiration

Use HTTPS for all API communications

Implement proper JWT token management with secure storage and rotation

User Experience Guidelines

Inform users about the 10-minute session limitation

Provide clear feedback when a session expires and guide users to restart the process

Display passbook details in a chronological and organized manner

Implement proper loading states while waiting for API response

Code Samples

cURL

Python

Node.js

Related APIs

EPFO Passbook Init API: Initiates the EPFO passbook retrieval process and provides the client_id

EPFO UAN Search API: Searches for UAN details using member information

EPFO Verification API: Verifies EPFO membership status

Compliance and Legal Considerations

The EPFO data retrieved through this API contains sensitive personal and financial information. Ensure you have proper consent from users before accessing their EPFO data. The use of this data must comply with relevant data protection regulations and privacy laws. Store and process this data securely, and use it only for the purposes explicitly consented to by the user.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/epfo-passbook-advanced/status' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "epfo_passbook_advanced_wfrrLtgaxcsiRQiyuqly" }'

{ "data": { "client_id": "epfo_passbook_advanced_ljNlWPBmnrhypGKdbygs", "uan": "100584578123", "full_name": "MOHIT YADAV", "mobile": "9123186987", "father_name": "Bhagwati Prasad", "dob": "1994-02-11", "details": [ { "member_id": "DSNHP10383380000010123", "est_name": "M.B.A CONSULTING INDIA PRIVATE LIMITED", "doj_epf": "2015-10-12", "passbook_details": [ { "employee_share": "297", "employer_share": "90", "pension_share": "207", "approved_on": "2017-11-15", "year": "2017", "month": "11", "description": "Cont. For Due-Month 112017" }, { "employee_share": "8", "employer_share": "3", "pension_share": "0", "approved_on": "2018-10-10", "year": "2017", "month": "04", "description": "Int. Updated upto 31/03/2018" }, { "employee_share": "331", "employer_share": "101", "pension_share": "0", "approved_on": "2019-04-22", "year": "2019", "month": "04", "description": "Claim Against PARA 69(2)" }, { "employee_share": "26", "employer_share": "8", "pension_share": "0", "approved_on": "2019-09-28", "year": "2019", "month": "03", "description": "Int. given against Claim " }, { "employee_share": "50218", "employer_share": "15367", "pension_share": "0", "approved_on": "2022-04-25", "year": "2022", "month": "04", "description": "TRANSFER IN - SAME OFFICE(Old Member Id-:DSNHP00239300000013943 )" }, { "employee_share": "356", "employer_share": "109", "pension_share": "0", "approved_on": "2022-04-25", "year": "2022", "month": "07", "description": "TRANSFER IN - INTEREST AMOUNT ONLY(Old Member Id-:DSNHP00239300000013943 )" } ] }, { "member_id": "DSNHP00239300000011234", "est_name": "ATS SERVICES PVT LTD", "doj_epf": "2015-10-12", "passbook_details": [ { "employee_share": "864", "employer_share": "264", "pension_share": "600", "approved_on": "2015-11-13", "year": "2015", "month": "11", "description": "Cont. For Due-Month 112015" }, { "employee_share": "1272", "employer_share": "389", "pension_share": "883", "approved_on": "2015-12-17", "year": "2015", "month": "12", "description": "Cont. For Due-Month 122015" }, { "employee_share": "1231", "employer_share": "377", "pension_share": "854", "approved_on": "2016-01-19", "year": "2016", "month": "01", "description": "Cont. For Due-Month 012016" } ] }, { "member_id": "PUPUN01206130000412345", "est_name": "CONNEQT BUSINESS SOLUTIONS LIMITED", "doj_epf": "2023-01-25", "passbook_details": [ { "employee_share": "163", "employer_share": "50", "pension_share": "113", "approved_on": "2023-03-15", "year": "2023", "month": "03", "description": "Cont. For Due-Month 032023" }, { "employee_share": "1262", "employer_share": "386", "pension_share": "876", "approved_on": "2023-04-13", "year": "2023", "month": "04", "description": "Cont. For Due-Month 042023" }, { "employee_share": "1262", "employer_share": "386", "pension_share": "876", "approved_on": "2023-05-13", "year": "2023", "month": "05", "description": "Cont. For Due-Month 052023" } ] }, { "member_id": "THTHA15499610000491234", "est_name": "INNOVSOURCE SERVICES PRIVATE LIMITED", "doj_epf": "2023-11-09", "passbook_details": [ { "employee_share": "1800", "employer_share": "550", "pension_share": "1250", "approved_on": "2023-12-14", "year": "2023", "month": "12", "description": "Cont. For Due-Month 122023" }, { "employee_share": "1800", "employer_share": "550", "pension_share": "1250", "approved_on": "2024-01-13", "year": "2024", "month": "01", "description": "Cont. For Due-Month 012024" } ] }, { "member_id": "GNGGN00104160000029999", "est_name": "SBI CARDS AND PAYMENT SERVICES LIMITED", "doj_epf": "2024-08-26", "passbook_details": [ { "employee_share": "425", "employer_share": "425", "pension_share": "0", "approved_on": "2024-09-13", "year": "2024", "month": "09", "description": "Cont. For Due-Month 092024" }, { "employee_share": "2125", "employer_share": "2125", "pension_share": "0", "approved_on": "2024-10-14", "year": "2024", "month": "10", "description": "Cont. For Due-Month 102024" } ] } ] }, "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 ********************

EPFO Passbook Status

EPFO Passbook Status#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Employment Details Object#

Passbook Details Object#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

EPFO Passbook Status

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Employment Details Object

Passbook Details Object

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples