EPFO Authentication & Passbook Pull (OTP Based)
The EPFO (Employees' Provident Fund Organisation) Passbook Pull API is a powerful API that enables individuals to retrieve their passbooks with ease. Using this API, individuals can access information such as their contribution to the provident fund, their employer's contribution, and interest earned on their savings. The API is designed to be user-friendly and accessible, allowing individuals to retrieve their passbook information quickly and efficiently.
This API is a game-changer for companies looking to retrieve their end customer's passbooks effortlessly from mobile numbers. As a first step, from the mobile number the UAN is fetched. Next, an OTP is triggered on the mobile number to take the consent of the end users to get their passbook details. With the Universal Account Number (UAN), this API retrieves all the relevant information linked to the passbooks. The API simplifies the process by mapping the UAN number with the passbooks and providing a wealth of information such as the company name, company id, member name, member id, date of joining the company, and employee and employer’s contribution towards the account.
Note - One mobile number can be linked with multiple UANs (Universal Account Numbers).
UAN stands for Universal Account Number, which is a unique identification number assigned to an individual's Provident Fund account. The UAN number is a 12-digit number that is issued by the Employees' Provident Fund Organisation (EPFO) and is linked to an individual's Provident Fund account throughout their career.
The UAN number remains the same even if an employee changes their job or Provident Fund account. It helps in tracking Provident Fund accounts across different employers and enables individuals to easily access their Provident Fund account information.
The UAN number also allows for the consolidation of multiple Provident Fund accounts under a single umbrella account, which makes it easier for individuals to manage their Provident Fund accounts. With the UAN number, individuals can access their Provident Fund account details, such as their balance and transaction history, through the EPFO portal and mobile app.
In order to pull the EPFO Passbook, the following steps are followed -
- An end-user has to input his/her mobile number.
- Once a mobile number is given, we do a Mobile To UAN Lookup to find the UAN number which is linked to the entered mobile number.
- If a UAN (Universal Account Number) number is found, it goes to the next step. Else, it stops here as there is no UAN number available that is linked with the entered mobile number.
- In cases where a UAN number is found, as a next step, an OTP (One-time Password) is triggered on the mobile number of the end user.
- The end-user has to input the OTP (one-time Password) that he/she has received on his/her mobile number.
- Once a successful OTP submission is done, it acts as consent from the end user to pull his/her EPFO Passbook. We pull the EPFO Passbook for the end user from the EPFO and send back the output.
EPFO Passbook Pull API consists of 3 separate APIs. They are -
This API is used to request a one time Password (OTP) that will be sent to the mobile number associated with the given UAN (Universal Account Number). This OTP can be used to authenticate the user in subsequent API calls.
This API is used to submit the OTP received from the user in response to the OTP request made in the previous API call. This API validates the OTP and returns a response with the request ID and status.
This API is used to get the passbook for the given UAN (Universal Account Number). This API requires the request ID returned from the Get OTP API call and returns the passbook details in JSON format.
The details of each of the 3 APIs can be found in subsequent pages.