Before you Start

To connect your UKG Pro account, you must create a service account in UKG Pro 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.

Overview: What You'll Need

You will complete two steps in UKG Pro:

1. Create a service account with the necessary permissions; this generates a username and password for the service user

2. Retrieve API and web service details

These values are created and stored in different areas of your UKG Pro system, which is why Finch collects them on two separate screens during the connection flow.

Step 1: Create a Service Account with the Necessary Permissions

Create a Username and Email for the Service Account

1. Log into UKG Pro as an administrator

2. Navigate to Menu > System Configuration > Security > Service Account Administration

3. Click Add

4. Enter a Username and E-mail

   1. Username: Enter your company name in lowercase without spaces

      1. Example: Acme Bread Co > acmebreadco

   2. E-mail: Enter your email address; Finch will not send any correspondence to this email

5. Copy the Username into Finch Connect

6. Ensure Generate New Password is selected

Assign the Service Account the Necessary Permissions

You will need to grant access to the following Web Services:

• View: Employee Pay Statement

• View: Company Configuration Integration

• View: Payroll Integration

• View: Personnel Integration

• View: Employee Job History Details

• View: Employee Person Details

Generate the Service Account Password

1. Once the required access is assigned to the service user, click save at the top of the page

   

2. This will automatically generate a password. We suggest you save this in a secure location

   

3. Copy the Password into Finch Connect

4. Click Ok in UKG

Step 2: Retrieve API Keys & Web Service URL

1. Navigate to Menu > System Configuration > Security > Web Services

2. Copy the User API Key into Finch Connect

3. Copy the Customer API Key into Finch Connect

4. Copy the Web Service URL into Finch Connect

   1. This is circled in red below

      

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.