Get EPFO Passbook API
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.
- 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:
- 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 |
- Headers:
- Content-Type: application/json
- Body:
- 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 |
Error Code | Description |
400 | Bad Request |
409 | Upstream is down |
500 | Internal Server Error |