EPFO Employee Name Based Search V2

4 min

Introduction

This API allows you to search for employee details in the Employee Provident Fund Organization (EPFO) database based on the establishment ID, establishment name, employee name, and employment month. The API returns a list of employee details that match the search criteria.

Sample cURL

curl --request POST \
  --url http://signzy.tech/api/v2/patrons/..your-patron-id../epfos \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"employeeNameSearchv2","essentials":{"establishmentId":"...establishmentId...","establishmentName":"...establishmentName...","employeeName":"...employeeName...","employmentMonth":"...employmentMonth..."}}'

Parameter	Description
task	The task to be performed by the API
establishmentId	The unique ID of the establishment
establishmentName	The name of the establishment
employeeName	The name of the employee to be searched
employmentMonth	The month of employment in format "MM/YYYY" of the employee
Access-Token	The access token required to authenticate the API request

Sample Response

{
   "result": {
        "match": "...match result (true/false)...",
        "searchResult": [
            {
                "establishmentName": "...establishmentName...",
                "establishmentID": "...establishmentID...",
                "address": "...address...",
                "officeName": "...officeName...",
                "paymentDetails": [
                    {
                        "trrn": "...transaction Id...",
                        "dateOfCredit": "...date of credit...",
                        "amount": "...amount...",
                        "wageMonth": "...wage month...",
                        "ecr": "...ecr (YES/NO)...",
                        "employeeMatch": [
                            "...matched employee names..."
                        ]
                    }
                ]
            }
        ]
    }
 }

Output Parameter	Description
match	A boolean value indicating whether the search resulted in a match or not.
searchResult	An array containing details of the establishments and their payment details that match the search criteria.
establishmentName	The name of the establishment.
establishmentID	The unique identifier of the establishment.
address	The address of the establishment.
officeName	The name of the office of the establishment.
paymentDetails	An array containing details of the payments made by the establishment.
trrn	The transaction ID of the payment.
dateOfCredit	The date on which the payment was credited.
amount	The amount of the payment.
wageMonth	The month for which the wages were paid.
ecr	A boolean value indicating whether the ECR was submitted for the wage month or not.
employeeMatch	An array containing the names of the employees who received the payment and match the search criteria.