EPFO Employee Name Based Search

4 min

Introduction

This API allows you to search for employees working in a particular establishment under the Employee Provident Fund (EPF) Scheme in India. This API searches for employee details based on their name and employment month. You can retrieve employee details such as their EPF account number, date of birth, father's name, and more. This API is useful for employers, compliance officers, and auditors who need to validate the employee details under EPF compliance.

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":"employeeNameSearch","essentials":{"establishmentId":"...establishmentId...","employeeName":"...employeeName...","employmentMonth":"...employmentMonth..."}}'

Parameter	Type	Required	Description
establishmentId	string	Yes	Unique identifier for the establishment
employeeName	string	Yes	Name of the employee
employmentMonth	string	Yes	Month and year of the employment in format "MMM-YYYY" (e.g. "Jan-2022")

Sample Response

{
   "result": {
       "establishmentId": "...establishmentId...",
       "establishmentName": "...establishmentName...",
       "validityStatus": {
           "establishmentStatus": "...establishmentStatus...",
           "registrationStatusOnEcrPortal": "...registrationStatusOnEcrPortal...",
           "postCoverageStatus": "..postCoverageStatus.."
       },
       "establishmentStatus": {
           "exemptionStatus": "...exemptionStatus...",
           "workingStatus": "...workingStatus..",
           "coverageSection": "..coverageSection..",
           "actionableStatus": "...actionableStatus...",
           "dateOfCoverage": "...dateOfCoverage..."
       },
       "establishmentDetails": {
           "panStatus": "..panStatus...",
           "sectionApplicable": "...sectionApplicable...",
           "primaryBusinessActivity": "...primaryBusinessActivity..",
           "esicCode": "...esicCode...",
           "ownershipType": "...ownershipType...",
           "dateOfSetupOfEstablishment": "..dateOfSetupOfEstablishment..",
           "address": "...address...",
           "pincode": "...pincode...",
           "city": "...city...",
           "district": "...district...",
           "state": "...state...",
           "country": "...country...",
           "epfoOfficeName": "...epfoOfficeName...",
           "epfoOfficeAddress": "...epfoOfficeAddress...",
           "zone": "...zone...",
           "region": "...region...",
           "splitAddress": {
               "state": [
                   []
               ],
               "district": [],
               "city": [],
               "pincode": "...pincode...",
               "country": [
                   "IN",
                   "IND",
                   "INDIA"
               ],
               "addressLine": "...addressLine..."
           }
       },
       "employeeNameSearchResponse": {
           "match": "...match...",
           "upstreamName": "...upstreamName...",
           "employeeList": ["..employeeList..."]
       }
   }
 }

Parameter Name	Data Type	Description
establishmentId	string	Unique identifier for the establishment
establishmentName	string	Name of the establishment
validityStatus	object	Object containing information on the validity of the establishment
establishmentStatus	object	Object containing information on the status of the establishment
establishmentDetails	object	Object containing details about the establishment
employeeNameSearchResponse	object	Object containing information on the employee name search response
establishmentStatus.exemptionStatus	string	Status of exemption of the establishment from EPF coverage
establishmentStatus.workingStatus	string	Status of the establishment whether it's working or not
establishmentStatus.coverageSection	string	Section of the Employees' Provident Funds and Miscellaneous Provisions Act, 1952 under which the establishment is covered
establishmentStatus.actionableStatus	string	Actionable status of the establishment whether it needs to take any action or not
establishmentStatus.dateOfCoverage	string	Date on which the establishment was covered under EPF
establishmentDetails.panStatus	string	Status of the Permanent Account Number (PAN) of the establishment
establishmentDetails.sectionApplicable	string	Section of the Employees' State Insurance (ESI) Act, 1948 under which the establishment is covered
establishmentDetails.primaryBusinessActivity	string	Primary business activity of the establishment
establishmentDetails.esicCode	string	Code of the Employees' State Insurance Corporation (ESIC) applicable to the establishment
establishmentDetails.ownershipType	string	Type of ownership of the establishment
establishmentDetails.dateOfSetupOfEstablishment	string	Date of establishment setup
establishmentDetails.address	string	Address of the establishment
establishmentDetails.pincode	string	Pincode of the establishment
establishmentDetails.city	string	City of the establishment
establishmentDetails.district	string	District of the establishment
establishmentDetails.state	string	State of the establishment
establishmentDetails.country	string	Country of the establishment
establishmentDetails.epfoOfficeName	string	Name of the EPFO office responsible for the establishment
establishmentDetails.epfoOfficeAddress	string	Address of the EPFO office responsible for the establishment
establishmentDetails.zone	string	Zone in which the establishment falls
establishmentDetails.region	string	Region in which the establishment falls
establishmentDetails.splitAddress	object	Object containing the address details of the establishment in separate fields
employeeNameSearchResponse.match	string	Whether the employee name search was successful or not
employeeNameSearchResponse.upstreamName	string	Name of the employee
employeeNameSearchResponse.employeeList	array	Array containing details of the employee(s) found in the search