Featured technology: ADP workers “hire” endpoint

ADP has published a single, robust endpoint used only for hiring new workers (there are separate endpoints for working with existing employees or contractors.) POST to this endpoint, along with information about the new worker, to create the first ever work agreement between your organization and this employee.

https://api.adp.com/​events/​hr/​v1/​worker.hire

Why Would Your Organization Need This Endpoint?

If your organization makes frequent new hires, or needs to work with employee/contractor data based in a different system besides core HR or Payroll, you may want to consider using the workers “hire” endpoint to automatically add new worker information.

  • POS Integration: insert new hires from any retail or restaurant location by entering them first in your POS, and then automatically importing to ADP.
  • Staffing: if your organization is adding new hire information to a staffing system, use the ADP workers “hire” endpoint to import new workers to the HRIS.
  • Recruiting and Applicant Tracking: organizations that use a non-ADP system for recruiting and applicant tracking may want new hires to automatically flow into the ADP system.

What Can the Workers “Hire” API Endpoint Do?

The workers “hire” endpoint is used for one thing only: hiring a new contractor or employee for the first time ever. Use the “on leave,” “rehire” or “terminate” endpoints to perform different updates on your employee data.

Adding an Employee: set your application to POST to the Workers “Hire” API endpoint and include the required “roleCode” HTTP header in your request. The body of your request can contain a significant level of detail, for illustration purposes we have included mostly high-level detail here:

POST https://api.adp.com/​events/​hr/​v1/​worker.hire
serviceCategoryCode: <object>
-- codeValue: hr
eventNameCode: <object>
-- codeValue: worker.hire
originator: <object>
-- (information about admin responsible for request)
actor: <object>
-- (information about admin, similar to "originator")
data: <object>
-- transform: <object>
-- -- eventStatusCode: <object>
-- -- -- codeValue: submit
-- -- effectiveDateTime: "2020-01-01T00:00:00Z"
-- -- worker: <object>
-- -- -- workerID: (object, information about worker ID)
-- -- -- person: (object, personal information such as...)
-- -- -- -- (birth date)
-- -- -- -- (gender)
-- -- -- -- (marital status)
-- -- -- -- (social insurance)
-- -- -- -- (immigration documents)
-- -- -- -- (passports)
-- -- -- -- (worker authorization documents)
-- -- -- -- (preferred name)
-- -- -- -- (former names)
-- -- -- -- (birth name)
-- -- -- -- (birth place)
-- -- -- -- (other personal addresses)
-- -- -- -- (race code)
-- -- -- -- (citizenship country codes)
-- -- -- -- (residency country codes)
-- -- -- -- (military status code)
-- -- -- -- (military classification codes)
-- -- -- -- (government IDs)
-- -- -- -- (legal name)
-- -- -- -- (legal address)
-- -- -- -- (communication)
-- -- -- workerDates: (object, original hire date)
-- -- -- workerStatus: (object, active status and reason for import)
-- -- -- businessCommunication: (object, business contact information)
-- -- -- workAssignment: (object, information about home department, supervisor, etc.)

How Can My Organization Build API Connectors For The Workers “Hire” Endpoint?

ADP uses an open API architecture, although it can take time to successfully obtain authorization to use the API. If your organization has an internal IT team or software development resources, you can create your own applications to connect to the Workers “Hire” API endpoint.

Valet Data Platform

Ensure payroll accuracy and simplify HCM workflows with Valet – connect your HCM system to external data sources to verify rates, streamline employee data and more.

  • Connect to external rate tables or applications
  • Validate time card or payroll data early in your process before inaccuracies stay in your system
  • Develop custom integrations or applications using Valet
  • Experience fantastic ongoing support

View all features >

Disclaimer: this educational content is provided “as-is” by Custom Interface Company, based on publicly available information, and is not meant to serve as official documentation or representation of functionality within or between any vendor system(s).

Leave a Comment

Your email address will not be published. Required fields are marked *