ADP Developer Resources

Chapter 1

About this API

Summary

ADP Workforce Now enables client practitioners to add new employees using the New Hire Template. The Applicant Onboard V2 Application Programming Interface (API) posts an applicant as an In-Progress and completed hire into ADP Workforce Now. This enables a practitioner to complete the hire by logging into ADP Workforce Now and add the new hire data.

What's New in this Guide?

April 2020

Added video walk through.
Moved Business Rules, TotalSource, Pre-Hire, and I-9 E-Verify information from the Required Setup to it's own section.
Added notes about system templates to the Required Setup section.
Added a bullet point regarding custom templates under the Required Setup section.
Updated Chapter 5 - Appendix.

March 2020

The following enhancements were added to the Applicant Onboard V2 API and the Applicant Onboard V2 API Guide for ADP Workforce Now:

Support for TotalSource clients
Support for Pre-Hire functionality
Support for E-Verify

Business Rules

Ask the New Hire option needs to be disabled under custom business rule, so only the Pre-Hire field will populate on the Hire page.
Minimum least age setup needs to be completed under custom business rule, so age validation happens while the New Hire process is completed.

TotalSource Clients

The TotalSource client enables templates in the ADP Workforce Now user interface (UI) by selecting Client Wizard > service selection and selecting the TotalSource check box.

Pre-Hire Functionality

To enable the preHire field in the ADP Workforce Now UI, select Client Wizard > service selection and select the WFN Onboarding Client check box.

I-9 Verify

To enable the E-verify field in the ADP Workforce Now UI, select Client Wizard > service selection and check the E Verify I9 Client check box.

Supported Product Version and Customer Base

All U.S. clients are on the most current version of the Applicant Onboard V2 API for ADP Workforce Now, including TotalSource clients.

Video Walk Through

Click here to view a video walk through of this guide

Process Overview

The following table shows an illustration of how your data connector application would be used by a client (this is a typical Business-to-Business (B2B) Application Integration Flow).

	Actor	Task Description
1	Client practitioner	Sets up required templates within ADP Workforce Now (as mentioned in the Appendix on page ) by selecting Setup > Template Management > Hire/Rehire.
2	Client practitioner	Makes sure each new hire is configured for an API supported template within the data connector application.
3	Client practitioner	Triggers the API-based data exchange between your data connector application and ADP Workforce Now.
4	Your data connector application	Sends new hire data using the Applicant Onboard V2 API.
5	Payroll practitioner

Required Setup

New Hire Templates

For practitioners to start the new hire process, ADP Workforce Now offers default templates. The Applicant Onboard V2 API also supports the following templates:

WFN with totalSource Client - system templates, which supports the following:
- TS New Hire (System)
- TS New Hire with Time (System)
  
  In order to use system templates, the practitioner should be set as a standard practitioner.
WFN Client - system template, which supports the following:
- International (System)
- HR + Payroll (System)
- HR + Payroll + Time (System)
- HR + Time (System)
- HR Only (System)
  
  In order to use system templates, practitioner should be set as standard practitioner.
Custom templates
Clients could also define custom templates by adding sections to a custom template.

See Chapter 5 - Appendix and go to the Steps to Create a New Hire Custom Template.

Postman Collection

Postman allows you to import a collection of APIs, created by others, so you can try them out. For more information on Postman, see Making Your First API Call Using Postman.

To download API collections for the Applicant Onboard V2 API from the ADP GitHub library and import them to Postman, go to Applicant Onboard Postman Collection.

Chapter 2

Use Case: Onboarding a Newly Hired Employee into the In-Progress Hire Process

Use Case Description

This use case inserts a newly hired employee into ADP Workforce Now using a specific template. This is so the HR practitioner can start the hiring process in ADP Workforce Now. A success request results in a new hire within Process > HR > Hire/Rehire.

API Usage

Method	URI	Description	GitHub Sample Request Payload	GitHub Sample Response Payload
GET	/hcm/v2/applicant.onboard/meta	Returns an applicant's metadata.	NA	ADP Workforce Now Client: applicant-meta-200.response.json ADP Workforce Now with TotalSource: totalSource_applicant-meta-200
GET	/hcm/v2/applicant.onboard/meta?$filter=meta/applicantOnboarding/onboardingTemplateCode/code eq '{ItemID}'	Retrieves the template code available for the client.	NA	ADP Workforce Now Client: applicant-meta-templateID-200 ADP Workforce Now with TotalSource: totalSource_applicant-meta_template
POST	/hcm/v2/applicant.onboard	Starts the applicant onboarding process (Inprogress state).	Inprogress-customTemplate-200.request.json	Inprogress-customTemplate-200.response.json

Method

URI

Description

GitHub Sample Request Payload

GitHub Sample Response Payload

GET

/hcm/v2/applicant.onboard/meta

Returns an applicant's metadata.

ADP Workforce Now Client:

applicant-meta-200.response.json

ADP Workforce Now with TotalSource:

totalSource_applicant-meta-200

GET

/hcm/v2/applicant.onboard/meta?$filter=meta/applicantOnboarding/onboardingTemplateCode/code eq '{ItemID}'

Retrieves the template code available for the client.

ADP Workforce Now Client:

applicant-meta-templateID-200

ADP Workforce Now with TotalSource:

totalSource_applicant-meta_template

POST

/hcm/v2/applicant.onboard

Starts the applicant onboarding process (Inprogress state).

Inprogress-customTemplate-200.request.json

Inprogress-customTemplate-200.response.json

Application Scope

The canonical uniform resource identifier (URI) corresponding to the API needs to be added in the Consumer Application Registry (CAR) for the subscription following which a user can access the Application Onboard V2 API and make successful API calls.

The following canonicals need to be added to your application scope to enable this use case:

/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicant.onboard
/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicant.onboard.meta.read

Request Header Parameters

None, in addition to the ADP standard header parameters.

Supported Actors

Request Parameter roleCode Value	Usage
Practitioner	Adds a newly hired employee into ADP Workforce Now. This is so an HR practitioner can complete the new hire process.

Sequence of Interactions

The following are the steps shown in the previous diagram:

Your consumer application makes a request to the ADP API endpoint for the Applicant-Onboard meta.
The ADP API endpoint responds to your consumer application with the meta payload, which lists the template code available for making the Applicant-Onboard call.
Your consumer application makes a request codelist call for the client to get the names of the templates available.
The ADP API endpoint responds with template names in the response payload.
Your consumer application makes a request with the payload to the ADP API endpoint for the Applicant-Onboard API.
The ADP API endpoint responds to the consumer application with the processing result.

Data Dictionary

The Applicant Onboard V2 API exposes ADP Workforce Now data displayed in the UI by selecting Process > HR > Hire/Rehire.

Fields in the following meta response are based on the setup done at client level within the ADP Workforce Now UI. To set up the fields, select SETUP > Template Management > Hire/Rehire > Fields Setup and choose Disabled, Optional, or Mandatory.
The benefits and Affordable Care Act (ACA) fields need to be enabled (checked) in the Client Wizard.

Schema Location	Field Name in ADP Workforce Now	Is Required (Y/N)	Applicable to All Templates?	Note
/applicantOnboarding/applicantOnboarding/onboardingTemplateCode/code	Hire Template	Y	Y	This is system required field.
/applicantOnboarding/onboardingStatus/ statusCode	Hire/Rehire Status	Y	Y	This is a system required field and indicates if the hire will be completed or pushed to an In-process state.
Employee Information
/applicantOnboarding/ applicantWorkerProfile/positionID	Position ID	Y		This is a system required field. Position ID is a concatenation of Company Code + File Number. For example: ABC123456, where ABC is the company code and 123456 is the File Number.
/applicantOnboarding/ applicantPayrollProfile/payrollFileNumber	File Number	Y		This is a system required field. File Number Is the unique number for an employee’s positions. For example:123456
/applicantOnboarding/ applicantWorkerProfile/job/jobCode/ applicantOnboarding/ applicantWorkerProfile/job/jobCode/code/applicantOnboarding/ applicantWorkerProfile/job/jobCode/name	Job Title	N
/applicantOnboarding/ applicantWorkerProfile/job/ occupationalClassifications/ classificationCode	EEOC Job Classification	N
/applicantOnboarding/ applicantWorkerProfile/payGradeCode/ applicantOnboarding/ applicantWorkerProfile/payGradeCode/ code/applicantOnboarding/ applicantWorkerProfile/payGradeCode/ name	Pay Grade	N
/applicantOnboarding/ applicantWorkerProfile/reportsTo/ positionID	Reports To
/applicantOnboarding/ applicantWorkerProfile/ managementPositionIndicator	Manager Position	N
/applicantOnboarding/ applicantWorkerProfile/ homeOrganizationalUnits/ applicantOnboarding/ applicantWorkerProfile/ homeOrganizationalUnits/nameCode/ applicantOnboarding/ applicantWorkerProfile/homeOrganizationalUnits/nameCode/code/ applicantOnboarding/ applicantWorkerProfile/ homeOrganizationalUnits/nameCode/ name/applicantOnboarding/ applicantWorkerProfile/ homeOrganizationalUnits/unitTypeCode/ applicantOnboarding/ applicantWorkerProfile/ homeOrganizationalUnits/unitTypeCode/ code/applicantOnboarding/ applicantWorkerProfile/ homeOrganizationalUnits/unitTypeCode/ name	Business Unit	N
/applicantOnboarding/ applicantWorkerProfile/homeWorkLocation/nameCode/applicantOnboarding/ applicantWorkerProfile/homeWorkLocation/nameCode/code/applicantOnboarding/ applicantWorkerProfile/homeWorkLocation/nameCode/name	Location	N
/applicantOnboarding/ applicantWorkerProfile/bargainingUnit/ bargainingUnitCode/applicantOnboarding/ applicantWorkerProfile/bargainingUnit/ bargainingUnitCode/code/ applicantOnboarding/ applicantWorkerProfile/bargainingUnit/ bargainingUnitCode/name	Union Local	N
/applicantOnboarding/ applicantWorkerProfile/laborUnion/ laborUnionCode/applicantOnboarding/ applicantWorkerProfile/laborUnion/ laborUnionCode/code/applicantOnboarding/applicantWorkerProfile/laborUnion/ laborUnionCode/name	Union Code	N
/applicantOnboarding/ applicantWorkerProfile/job/ wageLawCoverages/wageLawNameCode/applicantOnboarding/ applicantWorkerProfile/job/ wageLawCoverages/wageLawNameCode/code/applicantOnboarding/ applicantWorkerProfile/job/ wageLawCoverages/wageLawNameCode/name	FLSA	N
/applicantOnboarding/ applicantWorkerProfile/officerTypeCode/ code/applicantOnboarding/ applicantWorkerProfile/officerTypeCode/ code/code/applicantOnboarding/ applicantWorkerProfile/officerTypeCode/ code/name	Officer/Owner	N
/applicantOnboarding/ applicantWorkerProfile/job/ industryClassifications/classificationCode/ applicantOnboarding/ applicantWorkerProfile/job/ industryClassifications/classificationCode/ code/applicantOnboarding/ applicantWorkerProfile/job/ industryClassifications/classificationCode/ name	NAICS Workers Comp Code	N
/applicantOnboarding/ applicantWorkerProfile/ benefitsEligibilityClassCode/ applicantOnboarding/ applicantWorkerProfile/ benefitsEligibilityClassCode/code/ applicantOnboarding/ applicantWorkerProfile/ benefitsEligibilityClassCode/name	Benefits Eligibility Class	N
/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/ applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/ nameCode/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/ countryDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/ areaDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/ dialNumber/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/ extension/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/landlines/access	Work Phone	N
/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/faxes/ applicantOnboarding/ applicantWorkerProfile/ businessCommunication/faxes/ nameCode/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/faxes/ countryDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/faxes/areaDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/faxes/dialNumber/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/faxes/access	Work Fax	N
/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/mobiles/ applicantOnboarding/ applicantWorkerProfile/ businessCommunication/mobiles/ nameCode/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/mobiles/ countryDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/mobiles/ areaDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/mobiles/ dialNumber/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/mobiles/access	Work Cell	N
/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/ applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/ nameCode/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/ countryDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/ areaDialing/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/ dialNumber/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/ extension/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/pagers/access	Work Pager	N
/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/emails/emailUri	Work E-mail	N
/applicantOnboarding/ applicantWorkerProfile/ businessCommunication/emails/ notificationIndicator	Use For Notification	N
/applicantOnboarding/applicantWorkerProfile/hireDate	Hire Date	Y		This is a system required field.
/applicantOnboarding/applicantWorkerProfile/hireReasonCode	Reason for Hire	Y		This is a system required field.
/applicantOnboarding/workerID/id	Associate ID	Y		This is a system required field. Associate ID is a Unique ID to the employee that is at the person level and is the same even if the employee has multiple positions.
/applicantOnboarding/applicantWorkerProfile/payrollScheduleGroupCode	Pay Group	Y
/applicantOnboarding/applicantWorkerProfile/acaBenefitEligibilityCode/applicantOnboarding/applicantWorkerProfile/acaBenefitEligibilityCode/code/applicantOnboarding/applicantWorkerProfile/acaBenefitEligibilityCode/name	ACA Benefit Status	Y
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/address/countryCode	Country	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/address/lineOne	Address 1	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/address/lineTwo	Address 2	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/address/lineThree	Address 3	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/address/cityName	City	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/addresses/subdivisionCode/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/addresses/subdivisionCode/code/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/addresses/subdivisionCode/name	State / Province / Territory	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/addresses/postalCode	Zip/Postal Code	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/addresses/subdivisionCode2/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/addresses/subdivisionCode2/code	County	N
/applicantOnboarding/applicantWorkerProfile/homeWorkLocation/homeshoreIndicator	Works From Home	N
Personal Information
/applicantOnboarding/applicantPersonalProfile/languageCode/applicantOnboarding/applicantPersonalProfile/languageCode/code/applicantOnboarding/applicantPersonalProfile/languageCode/name	Correspondence Language	N
/applicantOnboarding/applicantPersonalProfile/governmentIDs/nameCode/applicantOnboarding/applicantPersonalProfile/governmentIDs/nameCode/code/applicantOnboarding/applicantPersonalProfile/governmentIDs/nameCode/name	Tax ID Type	Y
/applicantOnboarding/applicantPersonalProfile/governmentIDs/statusCode/applicantOnboarding/applicantPersonalProfile/governmentIDs/statusCode/code/applicantOnboarding/applicantPersonalProfile/governmentIDs/statusCode/name	Applied For	Y
/applicantOnboarding/applicantPersonalProfile/governmentIDs/id	Tax ID	Y		This is a system required field.
/applicantOnboarding/applicantPersonalProfile/legalName/salutations	Salutation	N
/applicantOnboarding/applicantPersonalProfile/birthName/givenName	First Name	Y		This is a system required field.
/applicantOnboarding/applicantPersonalProfile/birthName/middleName	Middle Name	N
/applicantOnboarding/applicantPersonalProfile/birthName/familyName	Last Name	Y		This is a system required field.
/applicantOnboarding/applicantPersonalProfile/legalName/givenName/applicantOnboarding/applicantPersonalProfile/birthName/familyName	Payroll Name	Y		This is a system required field.
/applicantOnboarding/applicantPersonalProfile/legalName/generationAffix	Generation Suffix	N
/applicantOnboarding/applicantPersonalProfile/legalName/qualificationAffix	Professional Suffix	N
/applicantOnboarding/applicantPersonalProfile/preferredName/nickName	Preferred Name	N
/applicantOnboarding/applicantPersonalProfile/genderCode/applicantOnboarding/applicantPersonalProfile/genderCode/code/applicantOnboarding/applicantPersonalProfile/genderCode/name	Gender	Y		This is a system required field.
/applicantOnboarding/ applicantPersonalProfile/birthDate	Birth Date	Y		This is a system required field.
/applicantOnboarding/ applicantPersonalProfile/legalAddress/ lineOne	Address 1	Y
/applicantOnboarding/ applicantPersonalProfile/legalAddress/ lineTwo	Address 2	N
/applicantOnboarding/ applicantPersonalProfile/legalAddress/ lineThree	Address 3	N
/applicantOnboarding/ applicantPersonalProfile/legalAddress/ cityName	City	Y
/applicantOnboarding/ applicantPersonalProfile/legalAddress/ subdivisionCode/applicantOnboarding/ applicantPersonalProfile/legalAddress/ subdivisionCode/code/applicantOnboarding/applicantPersonalProfile/legalAddress/ subdivisionCode/name	State / Province / Territory	Y
/applicantOnboarding/applicantPersonalProfile/legalAddress/subdivisionCode2/applicantOnboarding/applicantPersonalProfile/legalAddress/subdivisionCode2/code	County	N
/applicantOnboarding/applicantPersonalProfile/legalAddress/postalCode	Zip/Postal Code	Y
/applicantOnboarding/applicantPersonalProfile/legalAddress/deliveryPoint	Work Mail Stop	N
/applicantOnboarding/applicantPersonalProfile/otherPersonalAddresses/countryCode	Country	Y
/applicantOnboarding/applicantPersonalProfile/otherPersonalAddresses/lineOne	Address 1	N
/applicantOnboarding/applicantPersonalProfile/otherPersonalAddresses/lineTwo	Address 2	N
/applicantOnboarding/applicantPersonalProfile/otherPersonalAddresses/lineThree	Address 3	N
/applicantOnboarding/ applicantPersonalProfile/ otherPersonalAddresses/cityName	City	N
/applicantOnboarding/ applicantPersonalProfile/ otherPersonalAddresses/ subdivisionCode/applicantOnboarding/ applicantPersonalProfile/ otherPersonalAddresses/subdivisionCode/code/applicantOnboarding/ applicantPersonalProfile/ otherPersonalAddresses/subdivisionCode/name	State / Province/ Territory	N
/applicantOnboarding/applicantPersonalProfile/otherPersonalAddresses/postalCode	Zip/Postal Code	N
/applicantOnboarding/applicantPersonalProfile/communication/landlines/applicantOnboarding/applicantPersonalProfile/communication/landlines/nameCode/applicantOnboarding/applicantPersonalProfile/communication/landlines/countryDialing/applicantOnboarding/applicantPersonalProfile/communication/landlines/areaDialing/applicantOnboarding/applicantPersonalProfile/communication/landlines/dialNumber/applicantOnboarding/applicantPersonalProfile/communication/landlines/access	Home Phone	N
/applicantOnboarding/ applicantPersonalProfile/communication/ faxes/applicantOnboarding/ applicantPersonalProfile/communication/ faxes/nameCode/applicantOnboarding/ applicantPersonalProfile/communication/ faxes/countryDialing/applicantOnboarding/applicantPersonalProfile/communication/ faxes/areaDialing/applicantOnboarding/ applicantPersonalProfile/communication/ faxes/dialNumber/applicantOnboarding/ applicantPersonalProfile/communication/ faxes/access	Home Fax	N
/applicantOnboarding/ applicantPersonalProfile/communication/ mobiles/applicantOnboarding/ applicantPersonalProfile/communication/ mobiles/nameCode/applicantOnboarding/ applicantPersonalProfile/communication/ mobiles/countryDialing/ applicantOnboarding/ applicantPersonalProfile/communication/ mobiles/areaDialing/applicantOnboarding/ applicantPersonalProfile/communication/ mobiles/dialNumber/applicantOnboarding/ applicantPersonalProfile/communication/ mobiles/access	Personal Cell	N
/applicantOnboarding/ applicantPersonalProfile/communication/ pagers/applicantOnboarding/ applicantPersonalProfile/communication/ pagers/nameCode/applicantOnboarding/ applicantPersonalProfile/communication/ pagers/countryDialing/applicantOnboarding/applicantPersonalProfile/communication/ pagers/areaDialing/applicantOnboarding/ applicantPersonalProfile/communication/ pagers/dialNumber/applicantOnboarding/ applicantPersonalProfile/communication/ pagers/extension/applicantOnboarding/ applicantPersonalProfile/communication/ pagers/access	Personal Pager	N
/applicantOnboarding/ applicantPersonalProfile/communication/ emails/emailUri	Home Email	N
/applicantOnboarding/ applicantPersonalProfile/communication/ emails/notificationIndicator	Use For Notification	N
/applicantOnboarding/ applicantPersonalProfile/maritalStatusCode/applicantOnboarding/ applicantPersonalProfile/maritalStatusCode/code/applicantOnboarding/ applicantPersonalProfile/maritalStatusCode/name	Marital Status	N
/applicantOnboarding/ applicantPersonalProfile/maritalStatusCode/effectiveDateTime	Effective Date	N
/applicantOnboarding/ applicantPersonalProfile/raceCode/ identificationMethodCode/ applicantOnboarding/ applicantPersonalProfile/raceCode/ identificationMethodCode/code/ applicantOnboarding/ applicantPersonalProfile/raceCode/ identificationMethodCode/name	Ethnicity / Race ID Method	N
/applicantOnboarding/ applicantPersonalProfile/raceCode/ applicantOnboarding/ applicantPersonalProfile/raceCode/code/ applicantOnboarding/ applicantPersonalProfile/raceCode/name	Race	N
/applicantOnboarding/ applicantPersonalProfile/ethnicityCode/ applicantOnboarding/ applicantPersonalProfile/ethnicityCode/ code/applicantOnboarding/ applicantPersonalProfile/ethnicityCode/ name	Ethnicity	N
/applicantOnboarding/ applicantPersonalProfile/ tobaccoUserIndicator	Tobacco User	N
/applicantOnboarding/ applicantPersonalProfile/ socialInsurancePrograms/ applicantOnboarding/ applicantPersonalProfile/ socialInsurancePrograms/nameCode/ applicantOnboarding/ applicantPersonalProfile/ socialInsurancePrograms/nameCode/code/applicantOnboarding/ applicantPersonalProfile/ socialInsurancePrograms/nameCode/name/applicantOnboarding/ applicantPersonalProfile/ socialInsurancePrograms/coveredIndicator	Medicare Medicaid	N
/applicantOnboarding/ applicantPersonalProfile/disabledIndicator/applicantOnboarding/ applicantPersonalProfile/ disabilityTypeCodes	Section 503 Disability Status	N
Payroll Information
/applicantOnboarding/ applicantPayrollProfile/payrollGroupCode	Company Code	Y		This is a system required field.
/applicantOnboarding/ applicantPayrollProfile/payCycleCode/ applicantOnboarding/ applicantPayrollProfile/payCycleCode/code/applicantOnboarding/ applicantPayrollProfile/payCycleCode/ name	Pay Frequency	Y		This is a system required field.
/applicantOnboarding/ applicantPayrollProfile/baseRemuneration/applicantOnboarding/ applicantPayrollProfile/baseRemuneration/hourlyRateAmount/applicantOnboarding/ applicantPayrollProfile/baseRemuneration/hourlyRateAmount/amount/ applicantOnboarding/ applicantPayrollProfile/baseRemuneration/dailyRateAmount/applicantOnboarding/ applicantPayrollProfile/baseRemuneration/dailyRateAmount/amount/ applicantOnboarding/ applicantPayrollProfile/baseRemuneration/payPeriodRateAmount/ applicantOnboarding/ applicantPayrollProfile/baseRemuneration/payPeriodRateAmount/amount	Regular Pay Rate Rate Type
/applicantOnboarding/ applicantPayrollProfile/standardHours/ hoursQuantity	Standard Hours	N
/applicantOnboarding/ applicantPayrollProfile/ overtimeEligibilityIndicator	FLSA Overtime	N
/applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ codeFields/applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ codeFields/nameCode/ applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ codeFields/nameCode/code/ applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ codeFields/nameCode/name/ applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ codeFields/code/applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ codeFields/name	Data Control Clock	N
/applicantOnboarding/ applicantPayrollProfile/ additionalRemunerations/ applicantOnboarding/ applicantPayrollProfile/ additionalRemunerations/ remunerationTypeCode/ applicantOnboarding/ applicantPayrollProfile/ additionalRemunerations/ remunerationTypeCode/code/ applicantOnboarding/ applicantPayrollProfile/ additionalRemunerations/ remunerationTypeCode/name/ applicantOnboarding/ applicantPayrollProfile/ additionalRemunerations/ remunerationRate	Rate 2 Amount Rate 3 Amount Rate 4 Amount Rate 5 Amount Rate 6 Amount Rate 7 Amount Rate 8 Amount Rate 9 Amount	N
/applicantOnboarding/ applicantPayrollProfile/customFieldGroup/ stringFields/applicantOnboarding/applicantPayrollProfile/customFieldGroup/stringFields/nameCode/applicantOnboarding/applicantPayrollProfile/customFieldGroup/stringFields/nameCode/code/applicantOnboarding/applicantPayrollProfile/customFieldGroup/stringFields/nameCode/name/applicantOnboarding/applicantPayrollProfile/customFieldGroup/stringFields/stringValue	Custom Area 1 Custom Area 2 Custom Area 3 Custom Area 4	N
/applicantOnboarding/ applicantPayrollProfile/ tippedWorkerIndicator	Tipped Employee	N
/applicantOnboarding/ applicantPayrollProfile/wageEntityCode/ applicantOnboarding/ applicantPayrollProfile/wageEntityCode/ code/applicantOnboarding/ applicantPayrollProfile/wageEntityCode/ name	Wage Entity	N
Tax Information
/applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ taxWithholdingStatus/statusCode/ applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ taxWithholdingStatus/statusCode/code/ applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ taxWithholdingStatus/statusCode/name	Federal Marital Status	N
/applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ federalIncomeTaxInstruction/taxAllowances /applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ federalIncomeTaxInstruction/ taxAllowances/taxAllowanceAmount /applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ federalIncomeTaxInstruction/taxAllowances/allowanceTypeCode	*Deductions	Dependents*
/applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ multipleJobIndicator	Multiple jobs
/applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/federalIncomeTaxInstruction/additionalIncomeAmount	Other Income
/applicantOnboarding/applicantTaxProfile/ usFederalTaxInstruction/ federalIncomeTaxInstruction/ taxAllowanceQuantity	Federal Exemptions	N
/applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/ workedInJurisdictionIndicator	Worked In State	Y		This is a system required field.
/applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/ taxWithholdingStatus/statusCode/ applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/ taxWithholdingStatus/statusCode/code/ applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/ taxWithholdingStatus/statusCode/name	State Marital Status
/applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/ taxAllowanceQuantity	State Exemptions	N
/applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/ livedInJurisdictionIndicator/ applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/ stateIncomeTaxInstructions/stateCode	Lived In State	Y
/applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/suiTaxInstruction/ stateCode/applicantOnboarding/ applicantTaxProfile/usStateTaxInstructions/suiTaxInstruction/stateCode/code/ applicantOnboarding/applicantTaxProfile/ usStateTaxInstructions/suiTaxInstruction/ stateCode/name	SUI/SDI Tax Code	Y		This is a system required field.
/applicantOnboarding/applicantTaxProfile/ localTaxInstructions/ workedInJurisdictionIndicator /applicantOnboarding/applicantTaxProfile/ localTaxInstructions/localCode	Worked In Locality	Y
/applicantOnboarding/applicantTaxProfile/ localTaxInstructions/taxAllowanceQuantity	Local Exemptions	Y
/applicantOnboarding/applicantTaxProfile/ localTaxInstructions/ livedInJurisdictionIndicator/ applicantOnboarding/applicantTaxProfile/ localTaxInstructions/localCode	Lived In Locality	Y
/applicantOnboarding/applicantTaxProfile/ localTaxInstructions/taxTypeCode /applicantOnboarding/applicantTaxProfile/ localTaxInstructions/taxTypeCode/code	PA LST Local 4 PA LST Local 5 NY MTA Local OH(Ohio) School District	N

Responses

You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development.

For more information, see API Common Exceptions and Tips for Handling.

Response Code	Condition	messageTxt	GitHub Sample Request Payload	GitHub Sample Response Payload	Tips to Handle
201 Created	Response when using templateNameCode as Applicant Onboard in the request.	NA	Inprogress-customTemplate-200.request.json	Inprogress-customTemplate-200.response.json	Refer the payload values for creating a proper request.
201 Created	Response when using templateNameCode as HR Only (System) – U.S. in the request.	NA	Inprogress-HRonly-200.request.json	Inprogress-HRonly-200.response.json	Refer the payload values for creating a proper request.
201 Created	Response when using templateNameCode as HR + Time (System) – U.S. in the request.	NA	Inprogress-HRandTime-200.request.json	Inprogress-HRandTime-200.response.json	Refer the payload values for creating a proper request.
201 Created	Response when using templateNameCode as HR + Payroll (System) – US in the request.	NA	Inprogress-HRandPayroll-200.request.json	Inprogress-HRandPayroll-200.response.json	Refer the payload values for creating a proper request.
201 Created	Response when using templateNameCode as HR + Payroll + Time (System) – US in the request.	NA	Inprogress-HRpayrollTime-200.request.json	Inprogress-HRpayrollTime-200.response.json	Refer the payload values for creating a proper request.
201 Created	Response when using TS New Hire (System) in US in the request.	NA	totalSource_Inprogress_without_preHireField_201_request.json	totalSource_Inprogress_without_preHireField_201_response.json
201 Created	Response when pre-hire is true using TS New Hire (System) in US in the request.		totalSource_Inprogress_with_preHireField_201_request.json	totalSource_Inprogress_with_preHireField_201_response.json
400 Bad Request	Response when pre-hire is true but only mandatory fields are passed in the request payload.	"messageText": "You cannot ask the new hire until you complete these minimum required fields Associate ID, Hire Date, Home Email, First Name, Company Code, Last Name"	totalSource_Inprogress_preHire_ture_400_request.json	totalSource_Inprogress_preHire_ture_400_response.json
400 Bad Request	Response when first name is not passed in the request.	"userMessage": {"messageTxt": "You must enter a valid First Name."}	Inprogress-Empty-firstname-400.request.json	Inprogress-Empty-firstname-400.response.json	Refer the payload values for creating a proper request.
400 Bad Request	When last name is not passed in the request.	"userMessage": {"messageTxt": "You must enter a valid Last Name."}	Inprogress-Empty-lastname-400.request.json	Inprogress-Empty-lastname-400.response.json	Refer the payload values for creating a proper request.
400 Bad Request	Response when expected, start date is not passed in the request.	"userMessage": {"messageTxt": "Hire Date is required."}	Inprogress-Empty-hireDate-400.request.json	Inprogress-Empty-hireDate-400.response.json	Refer the payload values for creating a proper request.
400 Bad Request	Response when non-supported template name code is passed as in the request.	"userMessage": {"messageTxt": "Template is invalid."}	Inprogress-Invalid-templateCode-400.request.json	Inprogress-Invalid-templateCode-400.response.json	Refer the payload values for creating a proper request.
403 Forbidden	If Step 6 within the Chapter 5 - Appendix: Steps to Create a New Hire Template with the Name of Applicant Onboard is not performed, the user will receive this error while making a call for the Applicant Onboard API.	Forbidden error

Chapter 3

Use Case: Onboarding a Newly Hired Employee into the Complete Hire Process

Use Case Description

This use case hires an employee into ADP Workforce Now using a specific template. This is so the HR practitioner does not need to finish the hiring process in ADP Workforce Now. A success request results in a new hire being fully hired into ADP Workforce Now by selecting Process > HR > Hire/Rehire in the UI.

API Usage

Method	URI	Description	GitHub Sample Request Payload	GitHub Sample Response Payload
POST	/hcm/v2/applicant.onboard	This is used for hiring an employee completely.	complete-customTemplate-200.request.json	complete-customTemplate-200.response.json

Responses

You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development.

For more information, see API Common Exceptions and Tips for Handling.

Response Code	Condition	messageTxt	GitHub Sample Request Payload	GitHub Sample Response Payload
201 Created	Response using templateNameCode as Applicant Onboard in the request.	NA	complete-customTemplate-200.request.json	complete-customTemplate-200.response.json
201 Created	Response using templateNameCode as HR Only (System) – US in the request.	NA	complete-HRonly-200.request.json	complete-HRonly-200.response.json
201 Created	Response using templateNameCode as HR + Time (System) – US in the request.	NA	complete-HRtime-200.request.json	complete-HRtime-200.response.json
201 Created	Response using templateNameCode as HR + Payroll (System) – US in the request.	NA	complete-HRpayroll-200.request.json	complete-HRpayroll-200.response.json
201 Created	Response using templateNameCode as HR + Payroll + Time (System) – US in the request.	NA	complete-HRpayrollTime-200.request.json	complete-HRpayrollTime-200.response.json
Personal
400 Bad Request	Response when worker ID is not passed in the request.		complete-empty-workerID-400.request.json	complete-empty-workerID-400.response.json
400 Bad Request	Response when LegalName salutation is not passed in the request.		complete-empty-salutations-400.request.json	complete-empty-salutations-400.response.json
400 Bad Request	Response when n generation suffix is not passed in the request.		complete-empty-GenerationSuffix-400.request.json	complete-empty-GenerationSuffix-400.response.json
400 Bad Request	Response when qualification suffix is not passed in the request.		complete-empty-ProfessionalSuffix-400.request.json	complete-empty-ProfessionalSuffix-400.response.json
400 Bad Request	Response when preferred Nickname is not passed in the request.		complete-empty-preferredNickname-400.request.json	complete-empty-preferredNickname-400.response.json
400 Bad Request	Response when LanguageCode is not passed in the request.		complete-empty-languageCode-400.request.json	complete-empty-languageCode-400.response.json
400 Bad Request	Response when Gender is not passed in the request.		complete-empty-gender-400.request.json	complete-empty-gender-400.response.json
400 Bad Request	Response when birthdate is not passed in the request.		complete-empty-birthDate-400.request.json	complete-empty-birthDate-400.response.json
400 Bad Request	Response when tax ID type is not passed in the request.		complete-empty-taxID_type-400.request.json	complete-empty-taxID_type-400.response.json
400 Bad Request	Response when tax ID status is not passed in the request.		complete-empty-taxID-400.request.json	complete-empty-taxID-400.response.json
400 Bad Request	Response when Home phone is not passed in the request.		complete-empty-HomePhone-400.request.json	complete-empty-HomePhone-400.response.json
400 Bad Request	Response when personal cell is not passed in the request.		complete-empty-personalCell-400.request.json	complete-empty-personalCell-400.response.json
400 Bad Request	Response when Home email is not passed in the request.		complete-empty-HomeEmail-400.request.json	complete-empty-HomeEmail-400.response.json
400 Bad Request	Response when Home fax is not passed in the request.		complete-empty-HomeFax-400.request.json	complete-empty-HomeFax-400.response.json
400 Bad Request	Response when personal pager is not passed in the request.		complete-empty-personalPager-400.request.json	complete-empty-personalPager-400.response.json
400 Bad Request	Response when legal address 1 is not passed in the request.		complete-empty-legalAddress1-400.request.json	complete-empty-legalAddress1-400.response.json
400 Bad Request	Response when Legal address City is not passed in the request.		complete-empty-LegalAddress_City-400.request.json	complete-empty-LegalAddress_City-400.response.json
400 Bad Request	Response when Legal address sub divisionCode is not passed in the request.		complete-empty-subDivisioncode-400.request.json	complete-empty-subDivisioncode-400.response.json
400 Bad Request	Response when Legal address country is not passed in the request.		complete-empty-LegalAddress_country-400.request.json	complete-empty-LegalAddress_country-400.response.json
400 Bad Request	Response when Legal address postal code is not passed in the request.		complete-empty-legalAddress_postalCode-400.request.json	complete-empty-legalAddress_postalCode-400.response.json
400 Bad Request	Response when Secondary address 1 is not passed in the request.		complete-empty-secondaryAddress1-400.request.json	complete-empty-secondaryAddress1-400.response.json
400 Bad Request	Response when Secondary address city is not passed in the request.		complete-empty-secondaryAddress_City-400.request.json	complete-empty-secondaryAddress_City-400.response.json
400 Bad Request	Response when Secondary address sub divisionCode is not passed in the request.		complete-empty-secondaryAddress_subDivision-400.request.json	complete-empty-secondaryAddress_subDivision-400.response.json
400 Bad Request	Response when Secondary address country code is not passed in the request.		complete-empty-secondaryAddress_country-400.request.json	complete-empty-secondaryAddress_country-400.response.json
400 Bad Request	Response when Secondary address postal code is not passed in the request.		complete-empty-secondaryAddress_postalCode-400.request.json	complete-empty-secondaryAddress_postalCode-400.response.json
400 Bad Request	Response when marital status is not passed in the request.		complete-empty-maritalStatus-400.request.json	complete-empty-maritalStatus-400.response.json
400 Bad Request	Response when marital effectiveDateTime is not passed in the request.		complete-empty-MaritaleffectiveDate-400.request.json	complete-empty-MaritaleffectiveDate-400.response.json
400 Bad Request	Response when tobacco user is not passed in the request.		complete-empty-tobaccoUser-400.request.json	complete-empty-tobaccoUser-400.response.json
400 Bad Request	Response when medicare is not passed in the request.		complete-empty-medicare-400.request.json	complete-empty-medicare-400.response.json
400 Bad Request	Response when race ID is not passed in the request.		complete-empty-RaceID-400.request.json	complete-empty-RaceID-400.response.json
400 Bad Request	Response when ethnicity is not passed in the request.		complete-empty-ethnicity-400.request.json	complete-empty-ethnicity-400.response.json
Employment
400 Bad Request	Response when hire date is not passed in the request.		complete-empty-hireDate-400.request.json	complete-empty-hireDate-400.response.json
400 Bad Request	Response when worker category is not passed in the request.		complete-empty-workerCategory-400.request.json	complete-empty-workerCategory-400.response.json
400 Bad Request	Response when home department is not passed in the request.		complete-empty-businessUnit-400.request.json	complete-empty-businessUnit-400.response.json
400 Bad Request	Response when Job code is not passed in the request.		complete-empty-JobTitle-400.request.json	complete-empty-JobTitle-400.response.json
400 Bad Request	Response when Home cost Number is not passed in the request.		complete-empty-homeCostNumber-400.request.json	complete-empty-homeCostNumber-400.response.json
400 Bad Request	Response when work phone is not passed in the request.		complete-empty-WorkPhone-400.request.json	complete-empty-WorkPhone-400.response.json
400 Bad Request	Response when work cell is not passed in the request.		complete-empty-workCell-400.request.json	complete-empty-workCell-400.response.json
400 Bad Request	Response when work email is not passed in the request.		complete-empty-workEmail-400.request.json	complete-empty-workEmail-400.response.json
400 Bad Request	Response when work Fax is not passed in the request.		complete-empty-workFax-400.request.json	complete-empty-workFax-400.response.json
400 Bad Request	Response when work pager is not passed in the request.		complete-empty-workPager-400.request.json	complete-empty-workPager-400.response.json
400 Bad Request	Response when officer/owner is not passed in the request.		complete-empty-officer:owner-400.request.json	complete-empty-officer:owner-400.response.json
400 Bad Request	Response when union code is not passed in the request.		complete-empty-UnionCode-400.request.json	complete-empty-UnionCode-400.response.json
400 Bad Request	Response when union local is not passed in the request.		complete-empty-unionLocal-400.request.json	complete-empty-unionLocal-400.response.json
400 Bad Request	Response when benefits eligibility class is not passed in the request.		complete-empty-BenefitsEligibilityClass-400.request.json	complete-empty-BenefitsEligibilityClass-400.response.json
400 Bad Request	Response when ACA benefits status is not passed in the request.		complete-empty-ACABenefitStatus-400.request.json	complete-empty-ACABenefitStatus-400.response.json
Payroll
400 Bad Request	Response when payroll group code is not passed in the request.		complete-empty-companyCode-400.request.json	complete-empty-companyCode-400.response.json
400 Bad Request	Response when data control is not passed in the request.		complete-empty-dataControl-400.request.json	complete-empty-dataControl-400.response.json
400 Bad Request	Response when clock code is not passed in the request.		complete-empty-Clockcode-400.request.json	complete-empty-Clockcode-400.response.json
400 Bad Request	Response when regular payRate is not passed in the request.		complete-empty-regularPayRate-400.request.json	complete-empty-regularPayRate-400.response.json
400 Bad Request	Response when wage entity is not passed in the request.		complete-empty-WageEntity-400.request.json	complete-empty-WageEntity-400.response.json
Tax
400 Bad Request	Response when federal marital status is not passed in the request.		complete-empty-federalMaritalStatus-400.request.json	complete-empty-federalMaritalStatus-400.response.json
400 Bad Request	Response when federal exemptions is not passed in the request.		complete-empty-federalExemptions-400.request.json	complete-empty-federalExemptions-400.response.json
400 Bad Request	Response when lived in state is not passed in the request.		complete-empty-LivedInstate-400.request.json	complete-empty-LivedInstate-400.response.json

Chapter 4

Known Issues and Limitations

US905487: Fields not supported through the Application Onboard V2 API

Impacted APIs

Method	URI	roleCode Value
POST	/hcm/v2/applicant.onboard	practitioner
GET	/hcm/v2/applicant.onboard/meta	practitioner

Issue Description

The fields in the following table are not supported by the Applicant Onboard V2 API.

Template Applicable	Section	Field Name	Field Description
Applicant Onboard	Employment	How will this employee complete Form I-9
Applicant Onboard	Employment	E-Verify Work Location	Select the location where the employee will work. If you use E-Verify to determine this employee's eligibility to work in the United States (U.S.), then you must select a specific location. Otherwise, select Not Applicable. Important: You cannot leave this field blank.
Applicant Onboard	Tax	Worker's Compensation
Applicant Onboard	Tax	Employee Type for Qtrly Reporting	Indicates whether the employee lives Full Time or Part Time in the state, and in the State Unemployment Insurance (SUI)/State Disability Insurance (SDI) tax jurisdiction. This status will be included in the Quarterly Wage file where required by state law. It is not used for payroll purposes. If you update the state Employee Type, you should review the SUI/SDI Employee Type to determine if changes are needed.
Applicant Onboard	Time & Attendance	Badge Number	Insures an employee's time entries (In/Out) are connected to the employee's timecard.
Applicant Onboard	Time & Attendance	Include in Time Summary Payroll	Indicates you need to review a summary of the high-level settings for this pay class.
Applicant Onboard	Time & Attendance	Timeclocks Assigned	Indicates you need to select the time clocks that the employee will use to enter their time, such as In and Out punches.
Applicant Onboard	Time & Attendance	Timeclock Groups Assigned	Indicates you need to select the time clock groups containing multiple time clocks, if your company uses those, and you want individual employees to use more than one time clock. For example, multiple time clocks in one building.
Applicant Onboard	Time & Attendance	Timeclock Restriction Group	Indicates you need to select the Timeclock Restriction Group determining the specific period before and after the employee's scheduled In and Out time, during which the employee can record punches.
Applicant Onboard	Time & Attendance	Labor Charge Fields - Department	Indicates you need to enter the Labor Charge fields to specify the employee's default or home labor categories, such as Department or Job.
Applicant Onboard	Time & Attendance	Labor Charge Fields - TimeZone	Indicates you need to select the Time Zone for the candidate. For example: EST (Eastern Standard Time), CST (Central Standard Time), and so on.

F154681: Cannot complete onboard hire process, which already exists with Status as In Progress

Impacted APIs

Method	URI	roleCode Value
POST	/hcm/v2/applicant.onboard	practitioner
GET	/hcm/v2/applicant.onboard/meta	practitioner

Issue Description

This issue comes up when adding a template with the status of InProgress and having required field information. Then, the same template ID, workerID and file number is used and changes the status to complete with same information provided beforehand.

This adds a new record in the ADP Workforce Now UI.

Issue: Header field "ADP-Context-ExpressionID" is not working

Impacted APIs

Method	URI	roleCode Value
POST	/hcm/v2/applicant.onboard	practitioner
GET	/hcm/v2/applicant.onboard/meta	practitioner

Issue Description

The Applicant Onboard V2 API should have a header filter (if the header contains ADP-Context-ExpressionID:country={US or CA}), it should only display the templates based on the country value passed.

But currently, the default it is giving a CANADA response, regardless of the header value.

F154676: Applicant onboard V2 API does not support Canada templates

Impacted APIs

Method	URI	roleCode Value
POST	/hcm/v2/applicant.onboard	practitioner
GET	/hcm/v2/applicant.onboard/meta	practitioner

Issue Description

Currently, the Applicant Onboard V2 API currently does not support CANADA templates.
For a list of other issues, see Known Issues and Limitations on page .

F154678: Applicant Onboard V2 API does not support international templates

Impacted APIs

Method	URI	roleCode Value
POST	/hcm/v2/applicant.onboard	practitioner
GET	/hcm/v2/applicant.onboard/meta	practitioner

Issue Description

The Applicant Onboard V2 API currently does not support International templates.

Chapter 5

Appendix

Steps to Create a New Hire Template with the Name of Applicant Onboard

In ADP Workforce Now, go to Setup > Template Management > Hire/ReHire.
Next to any existing New Hire Template, select the check box and click Copy.
Next to Name of New Template enter Applicant Onboard. Then, click Yes.
To activate the Applicant Onboard template, click Yes. Then, click Applicant Onboard.
Click Assign Users.
Make sure Profile for system users established by Marketplace Data Connector applications is checked.
To confirm the user for your data connector application is assigned, click View Users in Selected Profiles.
Click Confirm Selections.
Click Done.

Any practitioner user who needs to participate in the hiring flow by delegation or workflow needs to be in the Assign Users section within ADP Workforce Now before any applicants are posted through the custom template. While configuring a new template, the Assign Users section can be seen as a tab on the left-hand side. After clicking Assign Users, you can see View Users in Selected Profiles. The client practitioner name should be populated in this list.
After the template is configured, permissions cannot be retroactively assigned to previously posted applicants.

Summary

What's New in this Guide?

April 2020

March 2020

Business Rules

TotalSource Clients

Pre-Hire Functionality

I-9 Verify

Supported Product Version and Customer Base

Video Walk Through

Process Overview

Required Setup

New Hire Templates

Postman Collection

Use Case Description

API Usage

Application Scope

Supported Actors

Sequence of Interactions

Data Dictionary

Responses

Use Case Description

API Usage

Responses

US905487: Fields not supported through the Application Onboard V2 API

Impacted APIs

Issue Description

F154681: Cannot complete onboard hire process, which already exists with Status as In Progress

Impacted APIs

Issue Description

Issue: Header field "ADP-Context-ExpressionID" is not working

Impacted APIs

Issue Description

F154676: Applicant onboard V2 API does not support Canada templates

Impacted APIs

Issue Description

F154678: Applicant Onboard V2 API does not support international templates

Impacted APIs

Issue Description

Steps to Create a New Hire Template with the Name of Applicant Onboard

Applicant Onboard v2 API Guide for Workforce Now