Merge

This guide will walk you through retrieving your Customer API Key and creating a Service User in UKG Pro to complete your linking flow. ​

Please ensure you fulfill all the requirements to set up the integration:

You are an Administrator in your company's UKG Pro instance, or someone has shared their access with you.

- You are an Administrator in your company's UKG Pro instance, or someone has shared their access with you.

Step 1: Find your UKG Pro Customer API Key

You'll want to login to your UKG Pro account and search Service Account Administration in your search bar on the top right ​

Copy the Customer API Key from under the header

Paste the Customer API Key in Merge Link ​

1. You'll want to login to your UKG Pro account and search Service Account Administration in your search bar on the top right ​
 
 
2. Copy the Customer API Key from under the header
3. Paste the Customer API Key in Merge Link ​

On the UKG Pro Service Account Administration Page, click on "+ add" in the upper right hand side ​

Enter in the admin of your UKG Pro account's username and email. You will need the username later ​

Scroll down under Web Service to enable permissions ​ View Employee Person Details is the minimum requirement to authenticate your account with Merge.

Depending on the use case, you may be required to add some, or all, of these permissions:

- Employee Pay Statement
- Employee Employment Information
- PTO Plan Integration
- Company Configuration Integration
- Payroll Integration
- Personnel Integration
- Employee Job History Details
- Employee Person Details
- Employee Compensation Details ​

Click Save. Your new password will pop up. Save the password in a secure location ​

Enter your UKG Pro service account credentials in Merge Link and click Submit ​ This should be the user name of your admin service user and the password you just generated ​

1. On the UKG Pro Service Account Administration Page, click on "+ add" in the upper right hand side ​
 
 
2. Enter in the admin of your UKG Pro account's username and email. You will need the username later ​
 
 
3. Scroll down under Web Service to enable permissions ​ View Employee Person Details is the minimum requirement to authenticate your account with Merge. 
 
 Depending on the use case, you may be required to add some, or all, of these permissions:
 - Employee Pay Statement
 - Employee Employment Information
 - PTO Plan Integration
 - Company Configuration Integration
 - Payroll Integration
 - Personnel Integration
 - Employee Job History Details
 - Employee Person Details
 - Employee Compensation Details ​
 
 
 
4. Click Save. Your new password will pop up. Save the password in a secure location ​
 
 
5. Enter your UKG Pro service account credentials in Merge Link and click Submit ​ This should be the user name of your admin service user and the password you just generated ​

Step 3: Finding your UKG Web Service Domain

In your search bar, search for Web Services ​

Look at any of the "web service endpoint URLs" and find your subdomain. ​ For example if your URL is, <a href="http://Servicet.ultipro.com/services/BIDataService" target="_blank" rel="nofollow noopener noreferrer">http://Servicet.ultipro.com/services/BIDataService</a> then your subdomain is "Servicet" ​

Find your top-level domain ​ For example if your URL is, <a href="http://Servicet.ultipro.com/services/BIDataService" target="_blank" rel="nofollow noopener noreferrer">http://Servicet.ultipro.com/services/BIDataService</a> then your top level domain is "ultipro.com" ​

1. In your search bar, search for Web Services ​
 
 
2. Look at any of the "web service endpoint URLs" and find your subdomain. ​ For example if your URL is, <a href="http://Servicet.ultipro.com/services/BIDataService" target="_blank" rel="nofollow noopener noreferrer">http://Servicet.ultipro.com/services/BIDataService</a> then your subdomain is "Servicet" ​
 
 
3. Find your top-level domain ​ For example if your URL is, <a href="http://Servicet.ultipro.com/services/BIDataService" target="_blank" rel="nofollow noopener noreferrer">http://Servicet.ultipro.com/services/BIDataService</a> then your top level domain is "ultipro.com" ​

On the "Enter your UKG Pro Web Services URL (Part 1)" screen, enter your subdomain ​

Click Submit. On the "Enter your UKG Pro Web Services URL (Part 2)" screen, select the URL that matches your top level domain ​

1. On the "Enter your UKG Pro Web Services URL (Part 1)" screen, enter your subdomain ​

2. Click Submit. On the "Enter your UKG Pro Web Services URL (Part 2)" screen, select the URL that matches your top level domain ​

Overview

Prerequisites

Video Guide

Instructions

Step 1: Find your UKG Pro Customer API Key

Step 2: Create your service account

Step 3: Finding your UKG Web Service Domain

Step 4: Complete the linking flow