> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# UKG Pro HRIS Integration
> UKG Pro connector for Kombo's HRIS API
This connector is in open beta. You can freely enable it in your account.
The UKG Pro HRIS integration allows you to sync HRIS data between UKG Pro and your application through Kombo's unified API. The tool slug for this connector is `ukgpro`.
## Guides and Resources
Step-by-step instructions to connect your UKG Pro account to Kombo.
## Supported Features & Coverage
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| address | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| address | |
| remote\_data | |
| Field | Notes |
| --------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_number | |
| first\_name | |
| last\_name | |
| nationality | |
| job\_title | |
| work\_email | |
| personal\_email | |
| mobile\_phone\_number | |
| ssn | |
| gender | |
| ethnicity | |
| marital\_status | |
| employment\_status | |
| employment\_type | |
| weekly\_hours | |
| work\_location\_id | |
| legal\_entity\_id | |
| manager\_id | |
| home\_address | |
| bank\_accounts | |
| date\_of\_birth | |
| start\_date | |
| termination\_date | |
| remote\_created\_at | |
| custom\_fields | |
| integration\_fields | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| unit | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| job\_title | |
| pay\_rate | |
| pay\_period | |
| pay\_frequency | |
| employment\_type | |
| effective\_date | |
| remote\_data | |
| custom\_fields | |
| integration\_fields | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| type | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| employee\_id | |
| type\_id | |
| balance | |
| balance\_unit | |
| used | |
| used\_unit | |
| remote\_data | |
| Field | Notes |
| -------------------- | ----- |
| id | |
| remote\_id | |
| changed\_at | |
| remote\_deleted\_at | |
| name | |
| model\_type | |
| description | |
| status | |
| employment\_types | |
| number\_of\_openings | |
| parent\_id | |
| remote\_url | |
| remote\_created\_at | |
| remote\_updated\_at | |
| custom\_fields | |
| integration\_fields | |
| remote\_data | |
| Field | Notes |
| ------------------- | ----- |
| employee\_id | |
| team\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
| Field | Notes |
| -------------------- | ----- |
| staffing\_entity\_id | |
| location\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
| Field | Notes |
| -------------------- | ----- |
| staffing\_entity\_id | |
| legal\_entity\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
| Field | Notes |
| -------------------- | ----- |
| staffing\_entity\_id | |
| group\_id | |
| id | |
| changed\_at | |
| remote\_deleted\_at | |
For detailed information about [creating employees with form](/hris/implementation-guide/create-employee), please see the [**Create Employee with Form** tab](#create-employee-with-form) above.
| Input Field | Notes |
| -------------------- | ----- |
| staffing\_entity\_id | |
| properties | |
| Feature | Notes |
| --------------------- | ----- |
| Connection Guide | |
| Create credentials | |
| API Passthrough | |
| Scope Testing | |
| Per Model Tests | |
| Group Types | |
| TEAM | |
| DEPARTMENT | |
| Custom Field Explorer | |
| Employments | |
The behavior of this action depends on your UKG Pro configuration. If you selected UKG Onboarding during setup, it will create a "New Hire" that needs to be onboarded. If you selected UKG Pro, it will create an employee directly in the system. For this option, you can only create employees for US Companies. If you need to create them for Canadian or Global companies, please contact support
This integration supports multiple employee creation forms for different use cases:
Some **optional** form fields are referencing the following data models:
* Employees
Consider enabling these in your [scope configuration](/hris/features/scopes).
**Form-specific constraints**
* Creates an employee directly in UKG Pro using the Import Tool API
**Key Fields**
**Company**
Unified field: `legal_entity_id`
**Effective Date**
**Personal Information**
**First Name**
Unified field: `first_name`
**Last Name**
Unified field: `last_name`
**Middle Name**
**Preferred Name**
**Former Name**
**Name Prefix**
**Name Suffix**
**Gender**
Unified field: `gender`
**Date of Birth**
Unified field: `date_of_birth`
**Marital Status**
**Home Phone**
**Business Phone**
**Business Phone Extension**
**Other Phone**
**Other Phone Type**
**Email Address**
Unified field: `private_email`
**Alternate Email**
**Mail Stop**
**Preferred Language For Pay Statement**
**Ethnic ID**
**Is Aboriginal**
**Is Visible Minority**
**Primary Address**
**Address Line 1**
Unified field: `home_address.street_1`
**Address Line 2**
Unified field: `home_address.street_2`
**City**
Unified field: `home_address.city`
**State/Province**
Unified field: `home_address.state`
**Country**
Unified field: `home_address.country`
**Zip/Postal Code**
Unified field: `home_address.zip_code`
**Status Information**
**Date of Last Hire**
Unified field: `start_date`
**Date of Original Hire**
**Date of Seniority**
**Date of Benefit Seniority**
**Job Information**
**Job Code**
**Location Code**
Unified field: `location_id`
**Pay Group**
**Pay Scale Code**
**Employee Type**
**Full or Part Time**
**Salary or Hourly**
**Hourly Pay Rate**
**Annual Salary**
Unified field: `yearly_salary`
**Scheduled Work Hours**
**Supervisor ID**
References `/v1/hris/employees?remote_model=employee`
**Earnings Group Code**
**Benefit Group Code**
**Job Group**
**Pay Automatically**
**Org Level 1 Code**
**Org Level 2 Code**
**Org Level 3 Code**
**US Taxes**
**Federal Filing Status Code**
**Federal Total Allowances**
**Federal Additional Amount Withheld**
**Federal Deduction Amount**
**Federal Employee Claims Exemption**
**State Unemployment Tax Plan**
**Work In Filing Status Code**
**Work In Total Allowances Claimed**
**Work In Deduction Amount**
**Work In Employee Claims Exemption**
**Work In Additional Amount Withheld**
**Identification**
**Social Security Number**
**Employee Number**
**National ID**
**Private Information**
**Birth Country Code**
Unified field: `nationality`
**Birth Location**
**Disability Type**
**Is Veteran**
**Is Disabled**
**Military Branch Code**
**Military Era Code**
**Is Disabled Veteran**
**Is Medal Veteran**
**Military Separation Date**
**Is Active Wartime Veteran**
**National ID Expiration Date**
**Primary Nationality Code**
Unified field: `nationality`
**Secondary Nationality Code**
**Tertiary Nationality Code**
**Work Permit Country**
**Work Permit Reference ID**
**Work Permit Application Date**
**Work Permit Approval Date**
**Work Permit Expiration Date**
**Is Pensioner**
**I9 Visa Type**
**I9 Expiration Date**
**I-9 Employment Eligibility**
**I9 Verified Code**
**I9 Document Number**
**I9 Expiration Date**
**I9 Document A Code**
**I9 Document B Code**
**I9 Document C Code**
**I9 Work Authorization**
**Direct Deposit Information**
**Account Number**
**Account Is Inactive**
**Amount or Percentage**
**Account Type**
**Routing Number**
**Bank Name**
**Deposit Rule**
**Institution Number**
**Is Pre-Note**
**Emergency Contacts & Dependents**
**Contact Information**
**First Name**
**Last Name**
**Middle Name**
**Former Name**
**Name Suffix**
**Relationship Code**
**Date of Birth**
**Gender**
**SSN**
**National ID**
**Is Emergency Contact**
**Is Dependent**
**Is Beneficiary**
**Is Active**
**Home Phone Country Code**
**Home Phone**
**Work Phone**
**Work Phone Country Code**
**Work Phone Extension**
**Preferred Phone**
**Email**
**Has Different Address**
**Address Line 1**
**Address Line 2**
**City**
**State/Province**
**Country**
**Zip/Postal Code**
Some **optional** form fields are referencing the following data models:
* Employees
* Legal Entities
Consider enabling these in your [scope configuration](/hris/features/scopes).
**Form-specific constraints**
* Creates a new hire in UKG Onboarding that will go through the onboarding process
**Contact Information**
Contact information for the new hire
**Name**
The name of the new hire
**First Name**
The first name of the new hire
Unified field: `first_name`
**Middle Name**
The middle name of the new hire
**Last Name**
The last name of the new hire
Unified field: `last_name`
**Former Last Name**
The former last name of the new hire
**Preferred First Name**
The preferred first name of the new hire
**Email Address**
The email address of the new hire
Unified field: `private_email`
**Primary Phone**
The primary phone number of the new hire
Unified field: `mobile_phone_number`
**Secondary Phone**
The secondary phone number of the new hire
**Address**
The address of the new hire
**Street 1**
The street address of the new hire
Unified field: `home_address.street_1`
**Street 2**
The street address of the new hire
Unified field: `home_address.street_2`
**City**
The city of the new hire
Unified field: `home_address.city`
**Postal Code**
The postal code of the new hire
Unified field: `home_address.zip_code`
**State Code**
The state code of the new hire
Unified field: `home_address.state`
**Country**
The country of the new hire
Unified field: `home_address.country`
**Country Code**
ISO country code of the address
**Job**
The job information for the new hire
**Job Code**
UKG Pro job code
Unified field: `job_title`
**Requisition ID**
RequisitionId of the job
**Component Company**
Component company of the job
Unified field: `legal_entity_id`
References `/v1/hris/legal-entities?remote_model=legal_entity`
**Work Location**
Work location of the job
Unified field: `location_id`
**Supervisor**
Supervisor of the job
References `/v1/hris/employees?remote_model=employee`
**Employee Type**
Employee type for the job
**Selected FLSA Status**
Selected FLSA status for the job.
**Organization Levels**
Organization levels for the new hire
**Organization Level 1**
Organization level 1 code
**Organization Level 2**
Organization level 2 code
**Organization Level 3**
Organization level 3 code
**Compensation**
Compensation information for the new hire
**Is Full Time**
Whether the new hire is full time
**Is Salaried**
Whether the new hire is salaried
**Work Hours**
Work hours of the new hire
**Weekly Hours**
Weekly hours of the new hire. Only applicable for hires not in US/Canadian companies
**Currency Code**
ISO currency code of the new hire
**Pay Rate**
Pay rate of the new hire
**Rate Per**
Pay period of the new hire.
**Onboarding Owner ID**
External user identifier of the onboarding owner
**Reference ID**
Customer-provided identifier to track the new hire against their own system
**Hire Date**
Hire date of the new hire
**Orientation Date**
Orientation date of the new hire
**Start Date**
Start date of the new hire
Unified field: `start_date`
**Past Start Date Reason**
Reason why the new hire start date is 4 or more business days in the past
**Mentor**
Mentor for the new hire
**Mentor**
Person from UKG Pro
References `/v1/hris/employees?remote_model=employee`
**Mentor Description**
Brief description of mentor
**Personal Message**
Personal message for the new hire
## Integration Variants
**Current connector:** UKG Pro
For **UKG Pro**, we also offer the following other connector variants:
UKG Pro for the ATS category
UKG Pro for the Assessment category