UKG Pro New Hire Integration Standard Setup

This article provided detailed information on the standard and recommended setup for the UKG Pro New Hire Integration, designed to ensure maximum stability and minimize errors.

Supported Fields

The following fields are included by default in the integration.

Personal Data

UK Pro Field Name	ClearCompany Data Source	Notes/Description
First Name	Standard Field - Candidate Profile	Required
Middle Name	Onboarding - Personal Data Sheet
Last Name	Standard Field - Candidate Profile	Required
Preferred First Name	Onboarding - Personal Data Sheet
Prefix	Onboarding - Personal Data Sheet
Suffix	Onboarding - Personal Data Sheet
Address Line1	Standard Field - Candidate Profile	Required
Address Line2	Standard Field - Candidate Profile
City	Standard Field - Candidate Profile	Required
State Or Province	Standard Field- Candidate Profile	Required
Zip Or PostalCode	Standard Field - Candidate Profile	Required
Country	Standard Field - Candidate Profile	Required
County	Onboarding - Personal Data Sheet
EmailAddress	Standard Field- Candidate Profile
Home Phone	Standard Field - Candidate Profile	Primary Phone Number
Other Phone	Standard Field - Candidate Profile	Secondary Phone Number
Other Phone Type	Fixed Value - CEL
Birth Date	Onboarding - Personal Data Sheet	Required
Ethnic Origin	Standard Field
Gender	Onboarding - Personal Data Sheet	Required Female Male Non-Binary is not a valid option via UKG's API.
SSN	Standard Field	Required
Marital Status	Onboarding - Personal Data Sheet	Single Married Widowed Divorced

Employment Data

UK Pro Field Name	ClearCompany Data Source	Notes/Description
Company Identifier	Requisition Custom Field	Required
Hire Date	Standard Field
Job Code	Standard Field	Required Role Code
Location Code	Standard Field	Required Office Code
Org Level 1	Requisition Custom FIeld
Org Level 2	Requisition Custom FIeld
Org Level 3	Requisition Custom FIeld
Employee Type	Requisition Custom FIeld	Required Regular Temporary Intern Contractor
Full Or PartTime	Requisition Custom Field	Required Full Time Part-Time Temporary is not a valid option in the UKG API.
Seniority Date	Standard Field	Required MM/dd/yyyy
Benefit Seniority Date	Standard Field	Required MM/dd/yyyy

Payroll Data

UK Pro Field Name	ClearCompany Data Source	Notes/Descriptions
Hourly Or Salaried	Requisition Custom Field	Required
Earnings Group	Requisition Custom Field	Required
Pay Automatically	Onboarding - Personal Data Sheet
Pay Group	Custom Requisition Field	Required
Pay Rate	System Field - Offer Letter Pay Rate	Required
Pay Rate Type	Onboarding - Personal Data Sheet	Required Hourly Period Weekly Yearly
Pay Scale Code	Onboarding - Personal Data Sheet
Scheduled Hours	Onboarding - Personal Data Sheet	Required

Direct Deposit

UK Pro Field Name	ClearCompany Data Source	Notes/Description
AccountNumber0	Onboarding - Direct Deposit Form
AccountType0	Onboarding - Direct Deposit Form	Checking Account Savings Account Debit Account
AmountRule0	Onboarding - Direct Deposit Form	Full Amount Fixed Amount Percent Amount
FlatOrPercentAmount0	Onboarding - Direct Deposit Form
RoutingNumber0	Onboarding - Direct Deposit Form
AccountNumber1	Onboarding - Direct Deposit Form
AccountType1	Onboarding - Direct Deposit Form	Checking Account Savings Account Debit Account
AmountRule1	Onboarding - Direct Deposit Form	Available Balance
RoutingNumber1	Onboarding - Direct Deposit Form

Federal Tax Information

UK Pro Field Name	ClearCompany Data Source	Notes/Description
Federal Additional Amount Withheld	Onboarding - W4	Step 4C on the Federal W4
Federal Deduction Amount	Onboarding - W4	Step 4B of the Federal W4
Federal Dependent Amount	Onboarding - W4	Step 3 from the Federal W4
Federal Employee Claims Exempt	Onboarding - W4	Step 4 from the Federal W4
Federal Filing Status	Onboarding - W4	Required Step 1C from the Federal W4
Federal Other Income	Onboarding - W4	Step 4A of the Federal W4

State Tax

UK Pro Field Name	ClearCompany Data Source	Notes/Description
Work State Disability Plan Type	Standard Field	Only required for the following states: CA, CO, CT, DC, MA, NJ, NY, OR, PR, WA.
Resident Jurisdiction		Required for PA Only
Resident State Filing Status	Onboarding - State Tax Form	Required
Resident County		Required for PA Only
Work State Filing Status	Onboarding - State Tax Form	Required
Work State Plan	Requisition Custom Field	Required for CA Only Valid Options: Z (State unem. (TPSP exempt from disability)) P (Personal income tax only) S (State disability and state unemployment) J (State disability only (exempt from UI)) A (State un. only (public entity EE only)) X (State unem. (religious exempt from dis.)) Y (State unem. (sole stockhold exempt from dis.)) U (Vol. disability and state unemployment) L (Vol. disability only (exempt from UI))
Deduction Benefit Group	Requisition Custom Field	Required
I9Verification	Fixed Value (Y)	Required
State Occupational Code	Onboarding - Personal Data Sheet	Required for AK - Alaska LA - Louisiana Employees with IN - Indiana work location Other states are not supported.

By following these guidelines, you can successfully transfer new hire data from ClearCompany to UKG and make use of the integrated features.