EPFO Detailed Establishment Number Based Search

4 min

Introduction

This API enables you to search for detailed Employee Provident Fund Organization (EPFOS) data of a patron's establishment by sending a POST request to the given endpoint URL.

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":"detailedEstablishmentSearch","essentials":{"establishmentId":"...establishmentId...","employeeListMonths":"...employeeListMonths..."}}'

Parameter	Type	Required	Description
patron-id	string	Yes	Unique identifier for the patron whose establishment's EPFOS data needs to be searched.
Access-Token	string	Yes	Authentication token for accessing the API.
establishmentId	string	Yes	Unique identifier for the establishment whose EPFOS data needs to be searched.
employeeListMonths	integer	Yes	Number of months for which employee list data needs to be fetched.

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..."
          }
      },
      "pfPaymentDetails": [{
          "transactionId": "...transactionId...",
          "dateOfCredit": "...dateOfCredit...",
          "timeOfCredit": "...timeOfCredit...",
          "amount": "...amount...",
          "wageMonth": "...wageMonth...",
          "noOfEmployees": "...noOfEmployees...",
          "employeeNames": ["..employeeNames..."]
      }]
  }
}

Parameter	Type	Description
establishmentId	string	Unique identifier for the establishment whose EPFOS data was searched.
establishmentName	string	Name of the establishment whose EPFOS data was searched.
validityStatus.establishmentStatus	string	Status of the establishment's EPFOS validity.
validityStatus.registrationStatusOnEcrPortal	string	Registration status of the establishment on the ECR portal.
validityStatus.postCoverageStatus	string	Post coverage status of the establishment.
establishmentStatus.exemptionStatus	string	Exemption status of the establishment.
establishmentStatus.workingStatus	string	Working status of the establishment.
establishmentStatus.coverageSection	string	Coverage section of the establishment.
establishmentStatus.actionableStatus	string	Actionable status of the establishment.
establishmentStatus.dateOfCoverage	string	Date of establishment's coverage.
establishmentDetails.panStatus	string	PAN status of the establishment.
establishmentDetails.sectionApplicable	string	Section applicable to the establishment.
establishmentDetails.primaryBusinessActivity	string	Primary business activity of the establishment.
establishmentDetails.esicCode	string	ESIC code of the establishment.
establishmentDetails.ownershipType	string	Ownership type of the establishment.
establishmentDetails.dateOfSetupOfEstablishment	string	Date of establishment's setup.
establishmentDetails.address	string	Address of the establishment.
establishmentDetails.pincode	string	Pincode of the establishment's address.
establishmentDetails.city	string	City of the establishment's address.
establishmentDetails.district	string	District of the establishment's address.
establishmentDetails.state	string	State of the establishment's address.
establishmentDetails.country	string	Country of the establishment's address.
establishmentDetails.epfoOfficeName	string	Name of the EPFO office.
establishmentDetails.epfoOfficeAddress	string	Address of the EPFO office.
establishmentDetails.zone	string	Zone of the establishment's address.
establishmentDetails.region	string	Region of the establishment's address.
establishmentDetails.splitAddress	object	Object containing split address information of the establishment.
pfPaymentDetails.transactionId	string	Transaction ID of the payment.
pfPaymentDetails.dateOfCredit	string	Date on which payment was credited.
pfPaymentDetails.timeOfCredit	string	Time at which payment was credited.
pfPaymentDetails.amount	string	Amount credited.
pfPaymentDetails.wageMonth	string	Wage month for which payment was credited.
pfPaymentDetails.noOfEmployees	string	Number of employees for which payment was credited.
pfPaymentDetails.employeeNames	array	Array of names of employees for which payment was credited.