Before you Start

To connect your UKG Ready account, you must create a service account in UKG Ready for the application you are connecting to.

If you need access to Deductions (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 three steps in UKG Ready:

1. Retrieve web service and company name details

2. Create a service profile with the necessary permissions

3. Create a service account; this generates a username, password, and API key for the service account

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

Step 1: Retrieve the Web Service URL and Company Short Name

Web Service URL

1. Log into UKG Ready

2. Open the lefthand menu bar

3. Navigate to Global Setup → Company Setup

4. Click on Company Info

5. Copy and paste the Web Service URL from your browser URL into Finch Connect

   

Company Short Name

1. On the same page, scroll down to the Company Address section

2. Copy the value from the Company Short Name field and paste this into Finch Connect

   

Step 2: Create a Security Profile

Create a Security Profile for Finch

1. Navigate to Settings → Profiles/Policies → Security

2. Click New Security Profile

3. Name the Security Profile: Finch Profile

   

Assign the Security Profile the Necessary Permissions

Immediately to the right of where you named the Security profile, you will grant the Security Profile access to the following Security Items:

Global Tab

Company Setup

• View: Address

Global Setup

• View: Company EINs

• View: Cost Center Definitions

• View: Employee Types

HR Tab

Employee Management

• View: Employee Information

• View: Base Compensation

• View: Cost Centers

• View: Jobs

• View: Social Security

• View: Total Compensation

Modules Tab

Rest API Resources

• View: Employee Demographics

• View: Employee Pay Information

• View: Employee Profiles

• View: Employees

Reports Tab

Reports

• Export Reports: CSV/Text

Save the Service Profile with the Assigned Permissions

1. Click Save at the top of the page

2. You should get a successful save notification

   

Enable the Service Account Login Config

1. Open the lefthand menu bar

2. Navigate to Global Setup > Company Setup

3. Click on Edit Tabs

   

4. Click on the Login Config under My Tabs

5. Locate Service Accounts under Available Windows

   

6. Drag Service Accounts into Column #3

   

7. Click Save

Step 3: Create a Service Account

Create a Username and Password

1. Navigate back to Global Setup > Company Setup

2. Click on Login Config

   

3. Scroll to the bottom of the page and click Add Service Account

   

4. Fill in the following information:

   

   1. Username: This can be the first 3 letters of your company followed by "Support" (Example: ABC Company > ABCSupport)

      1. Copy this value into Finch Connect

   2. Password: Create a password that meets the security requirements

      1. Copy this value into Finch Connect

   3. Security Profile: Select the security profile created in Step 1

   4. Account Groups: Select All Company Employees

5. Click Save

Retrieve API Keys

1. On the same Login Config tab, scroll down to the section API Keys

2. Copy the value from the REST API key field and paste this into Finch Connect