Overview

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

Prerequisites

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

Instructions

Step 1: Find your UKG Pro Customer API Key

1. Log in to UKG Pro and search "Service Account Administration" on the top right

   

2. Copy the Customer API Key from under the header

   

3. Paste the Customer API Key in the linking flow

   

Step 2: Create your service account

1. On the Service Account Administration Page, click "+ add" on the top right

   

2. Create a new username and email for your service account.You will need the username later

   

3. On the same page, scroll down under Web Service to enable "View Employee Person Details". This is REQUIRED.

   

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

   1. Employee Pay Statement

   2. Employee Employment Information

   3. PTO Plan Integration

   4. Company Configuration Integration

   5. Payroll Integration

   6. Personnel Integration

   7. Employee Job History Details

   8. Employee Compensation Details

   9. Employee User Defined Fields

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

6. Enter your UKG Pro service account credentials in the linking flow and click Submit. This is user username of your service user and the password you just generated.

Step 3: Finding your UKG Web Service Domain

1. In your search bar, search for Web Services

   

2. Look at any of the URLs on this page and copy one of them. For example your URL may look something like this: http://Servicet.ultipro.com/services/BIDataService

   

3. Enter the URL into the linking modal.