HRIS API Integration: How to integrate with UKG Ready or Pro

⚠️ Prerequisites: You must be an Administrator in your company’s UKG Ready or Pro instance, or have access permissions shared with you.

🔁 UKG Ready Integration

Overview

To authenticate your UKG Ready account, you’ll need:

• Domain

• Company Short Name

• API Key

• User ID

• Password

Step-by-Step Instructions

✅ Step 1: Enter Your Domain

From your login URL (e.g., acme.com/ta/Default.login), extract the domain—acme.com—and enter it into the linking flow.

✅ Step 2: Retrieve Your Company Short Name

1. Login to UKG Ready.

2. Open the left menu → go to Settings → Global Setup → Company Setup.

3. Open Company Info and scroll to Company Address.

4. Copy your Company Short Name and paste it in the linking flow.

✅ Step 3: Retrieve or Create Your API Key

1. Go to Login Config within Company Setup.

2. Scroll to API Keys. Click the 👁️ icon to reveal the key.
   *If no key exists, click Generate (⚠️ avoid this if other integrations rely on the existing key).

3. Copy and paste the API Key in the linking flow.

✅ Step 4: Create a Security Profile

1. Navigate to Settings → Profiles/Policies → Security → New Security Profile.

2. Ensure the following permissions are enabled:

HR Tab:

• Employee Management → Base Compensation → View

• Benefit Management (Plans) → View

• Cost Centers, Total Compensation, HR Custom Values → View

Leave of Absence Management:

• Manage Requests → Enabled (if applicable)

Modules Tab (if applicable):

• Rest API Resources → Employee Demographics, HR Custom Fields, Profiles, Pay Information, Employees → Enabled

Global Tab:

• Global Setup → Company EINs, Cost Center Definitions, Leave Custom Fields Definitions → View

• Object Lists → Company EINs, Cost Centers, Leave Categories, Pay Period Profiles → View

Payroll Tab:

• Payroll → Create/Edit Payroll, Payroll Prep Process, Payroll Adjustments → View/Edit/Add

✅ Step 5: Create a Service Account

1. Go to Settings → Global Setup → Company Setup → Edit Tabs.

2. Drag Service Accounts to the Top section, then click Save.

3. Click Add Service Account, provide:

• Username & password

• The Security Profile you created

• Account Group → All Company Employees

✅ Step 6: Complete the Linking Flow

Use the Service Account’s User ID and Password to finalize the connection

 

🔁 UKG Pro Integration

Overview

To integrate with UKG Pro, you’ll need:

Customer API Key

• Service Account Username

• Service Account Password

• Web Service Domain

Step-by-Step Instructions

✅ Step 1: Get Your Customer API Key

1. Log in to UKG Pro.

2. Search Service Account Administration.

3. Copy the Customer API Key and paste it in the linking flow.

✅ Step 2: Create a Service Account

1. On the same Service Account Administration page, click + Add.

2. Enter the username and email of your admin user.

   • Scroll to the Web Service section and enable: View Employee Person Details (mandatory)

3. Click Save. A password will be generated—store it securely.
   Depending on your needs, also enable:

   - Employee Pay Statement

   - Employment Information

   - PTO Plan Integration

   - Company Configuration Integration

   - Payroll/Personnel Integration

   - Job History

   - Compensation Details

4. Enter the Service Account username and password into the linking flow

✅ Step 3: Find Your Web Service Domain

1. Search for Web Services.

2. Copy any available URL (e.g., http://Servicet.ultipro.com/services/BIDataService).

3. Paste this domain into the linking flow to complete the setup.

✅ Final Notes

• Double-check that all credentials are accurate before submitting.

• All permissions listed are based on typical use cases—adjust as needed based on your specific integration goals.

• If issues arise during setup, contact your UKG system administrator or support team.