Get EPFO Passbook API

Description

This API is used to get the passbook for the given mobile number which has an UAN account. This API requires the request ID returned from the Get UAN OTP API call and returns the entire EPFO passbook details in JSON format.

Request

Method: POST
URL:
- Preproduction - https://api-preproduction.signzy.app/api/v3/underwriting/fetch-passbook
- Production - https://api.signzy.app/api/v3/underwriting/fetch-passbook
Headers:
- Authorization: The API key required to authenticate the request. Please use the key that you will receive from our sale, csm or the support team.
- Content-Type: application/json
Body:

{
    "txnId": ""
}

Request Parameters:

Key	Description	Mandatory/Optional	Type
txnId	The unique identifier for the OTP request. You get the requestId in the output of "Get OTP API".	Mandatory	String

Sample Request

curl --location 'https://api.signzy.app/api/v3/get-passbook' \
--header 'Authorization: <API Key>' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "income_epfo_passbook_RtYaUloStsydFpijZkfxyuoiee"
}'

Response

Headers:
- Content-Type: application/json
Body:

{
    "data": {
        "requestId": "income_epfo_passbook_RtYaUloStsydFpijZkfxyugdwdjwjjbjbw",
        "uan": "<UAN Number>",
        "fullName": "<Name>",
        "fatherName": "<Father's Name>",
        "dob": "YYYY-MM-DD",
        "companies": {
            "DLCPM00308150000019355": {
                "passbook": [
                    {
                        "member_id": "DLCPM00308150000019355",
                        "credit_debit_flag": "C",
                        "doe_epf": "YYYY-MM-DD",
                        "doe_eps": "YYYY-MM-DD",
                        "doj_epf": "YYYY-MM-DD",
                        "office": null,
                        "transaction_approved": "YYYY-MM-DD",
                        "transaction_category": "ob_interest",
                        "employee_share": "0",
                        "employer_share": "0",
                        "pension_share": "0",
                        "approved_on": "YYYY-MM-DD",
                        "year": "2017",
                        "month": "04",
                        "description": "OB Int. Updated upto 31/03/2017"
                    },
                    {
                        "member_id": "DLCPM00308150000019355",
                        "credit_debit_flag": "C",
                        "doe_epf": "YYYY-MM-DD",
                        "doe_eps": "YYYY-MM-DD",
                        "doj_epf": "YYYY-MM-DD",
                        "office": null,
                        "transaction_approved": "YYYY-MM-DD",
                        "transaction_category": "contribution",
                        "employee_share": "1800",
                        "employer_share": "550",
                        "pension_share": "1250",
                        "approved_on": "YYYY-MM-DD",
                        "year": "2023",
                        "month": "02",
                        "description": "Cont. For Due-Month 022023"
                    }
                ],
                "company_name": "<Company Name>",
                "establishment_id": "DLCPM0030815000",
                "employee_total": 2000,
                "employer_total": 2000,
                "pension_total": 5000
            }
          }
        },
        "incomeDetails": {
            "salary": <Predicted Salary>,
            "confidence_score": <Confidence Score>,
            "current_company_name": "<Current Employer Name>",
            "current_establishment_id": "<Current Establishment ID>"
        }
    }
}

Response Parameters:

Key	Description	Type
requestId	The request ID which will be used in Submit OTP and Get EPFO Passbook API calls	String
uan	UAN Number	String
fullName	Full Name	String
fatherName	Father Name	String
dob	Date Of Birth	String
companies	List of all the companies (Member ID of the employee for each of the company) where the employee has worked in the past and PF was deposited by the company to EPFO on behalf of the employee	Array Of Objects
passbook	List of each of the passbook entry	Object
member_id	Member ID of the employee for the company where he/she has worked	String
credit_debit_flag	Is the transaction being reported a credit or debit? D-Debit, C-Credit	String
doe_epf	Date of exit from the EPF (Employee Provident Fund)	String
doe_eps	Date of exit from the EPS (Employee Pension Scheme)	String
doj_epf	Date of Joining the EPF (Employee Provident Fund)	String
office	Details of office	String
transaction_approved	Date of transaction approval	String
transaction_category	Category of transaction	String
employee_share	Amount of employee share which was deposited in INR	String
employer_share	Amount of employer share which was deposited in INR	String
pension_share	Amount of pension share which was deposited in INR	String
approved_on	Date of approval	String
year	Year in which this transaction happened	String
month	Month in which this transaction happened	String
description	Description of the transaction	String
company_name	Name of the company	String
establishment_id	Establishment ID of the company	String
employee_total	Total contribution of the employee	String
employer_total	Total contribution of the employer	String
pension_total	Total pension contribution	String
incomeDetails	Details of income that is being predicted by Signzy's algorithm	String
salary	Salary of the employee being predicted by Signzy's algorithm (This is for the current company)	String
confidence_score	Confidence score of the prediction being made by Signzy's algorithm (This is for the current company)	String
current_company_name	Name of the current company where the employee is working	String
current_establishment_id	Establishment ID of the current company where the employee is working	String

Sample Responses

{
    "data": {
        "requestId": "income_epfo_passbook_RtYaUloStsydFpijZkfxyugdwdjwjjbjbw",
        "uan": "<UAN Number>",
        "fullName": "<Name>",
        "fatherName": "<Father's Name>",
        "dob": "YYYY-MM-DD",
        "companies": {
            "DLCPM00308150000019355": {
                "passbook": [
                    {
                        "member_id": "DLCPM00308150000019355",
                        "credit_debit_flag": "C",
                        "doe_epf": "YYYY-MM-DD",
                        "doe_eps": "YYYY-MM-DD",
                        "doj_epf": "YYYY-MM-DD",
                        "office": null,
                        "transaction_approved": "YYYY-MM-DD",
                        "transaction_category": "ob_interest",
                        "employee_share": "0",
                        "employer_share": "0",
                        "pension_share": "0",
                        "approved_on": "YYYY-MM-DD",
                        "year": "2017",
                        "month": "04",
                        "description": "OB Int. Updated upto 31/03/2017"
                    },
                    {
                        "member_id": "DLCPM00308150000019355",
                        "credit_debit_flag": "C",
                        "doe_epf": "YYYY-MM-DD",
                        "doe_eps": "YYYY-MM-DD",
                        "doj_epf": "YYYY-MM-DD",
                        "office": null,
                        "transaction_approved": "YYYY-MM-DD",
                        "transaction_category": "contribution",
                        "employee_share": "1800",
                        "employer_share": "550",
                        "pension_share": "1250",
                        "approved_on": "YYYY-MM-DD",
                        "year": "2023",
                        "month": "02",
                        "description": "Cont. For Due-Month 022023"
                    }
                ],
                "company_name": "<Company Name>",
                "establishment_id": "DLCPM0030815000",
                "employee_total": 2000,
                "employer_total": 2000,
                "pension_total": 5000
            }
          }
        },
        "incomeDetails": {
            "salary": <Predicted Salary>,
            "confidence_score": <Confidence Score>,
            "current_company_name": "<Current Employer Name>",
            "current_establishment_id": "<Current Establishment ID>"
        }
    }
}

Error Codes

Error Code	Description
400	Bad Request
409	Upstream is down
500	Internal Server Error

Sample Error Responses

{
    "error": {
        "name": "error",
        "message": "",
        "status": 400,
        "reason": "Error",
        "type": "OK",
        "statusCode": 200
    }
}