How can we help you?

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. For each of the permissions below, check the box to enable it and set the access level to View.
   All of these are required:
   1. Employee Person Details 
   2. Employee Employment Information 
   3. Employee User Defined Fields 
   4. Personnel Integration
   5. Company Configuration Integration

   6. Employee Job History Details

      
      

       

      Note: Depending on how you want to use it, you may want to additional permissions.
      
       

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 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.