Before you start

To connect your UKG Pro (UltiPro) account, you must create a service account for the application you are connecting to. If you already have a service account, you may use that one.

If you need access to Benefits data, follow the instructions below as well as the instructions listed HERE to add an administrator to support the benefits scope.

• For Organization Only data (Individual, Employer, and Directory end points) all fields with ✅ are required.
• For Pay and Organization data, (Individual, Employer, and Directory end points) all fields with 🔷 are required

Instructions

1. Log in to UKG and navigate to Menu > System Configuration > Service Account Administration and click Add.

2. Enter a User name and E-mail. These fields can be anything you want. The e-mail does not need to exist. Copy and paste the user name into Finch Connect.

3. In Finch Connect, you were shown a list of permissions on the page that linked to these directions. Please make sure to scroll through that entire list as you will need to add them all in this step. Here is an example screenshot from Finch Connect (your permissions may be different and there may be more than 3).

If your team uses this application to sync Organization data only

You will need access to the following permissions:

- Company Configuration Integration ✅ 
- Employee Job History Details ✅ 
- Employee Person Details ✅ 
- Personnel Integration ✅ 

If your team uses this application to sync Organization and Payroll data

You will need access to the following permissions:

- Company Configuration Integration 🔷
- Employee Job History Details 🔷
- Employee Pay Statement 🔷
- Employee Person Details 🔷
- Payroll Integration 🔷
- Personnel Integration 🔷

In UKG Pro, on the permissions grid, select View for each permission listed in your Finch Connect (example screenshot above). Please note the screenshot from UKG Pro below is an example (the permissions checked may not match the requirements for your data - you must reference the list in Finch Connect).

4. Click Save.

5. Copy and paste the generated password into Finch Connect. We also suggest you save it in a secure location.

6. Navigate to Security > Web Services and copy and paste the User API Key AND the Customer API Key into Finch Connect’s API Key field.

7. On the same page, find the Service Endpoint Subdomain by copying the subdomain from one of the endpoints (example: https://[subdomain].ultipro.com). Copy and paste the [subdomain] value into Finch Connect.

If your team uses this application to update deductions and contributions

As noted above, after completing these instructions, follow the instructions listed HERE to add an administrator to support the benefits scope.