UKG Ready Connection

You will gather a few UKG Ready account details, create secure integration access, and enter those details in your secure Clarity connection link.

BEFORE YOU BEGIN

You will need administrator access to UKG Ready and permission to manage Company Setup, Security Profiles, and Service Accounts.

Find Your Company Details

Locate the domain name and company short name used by your UKG Ready account.

Open your secure Clarity connection link and select Allow and Continue.
In UKG Ready, copy your domain name from the login URL. Enter only the portion after https:// and before /ta/.
Go to Settings > Global Setup > Company Setup > Company Info. Copy the Company Short Name and enter it when prompted.

Enter the UKG Ready domain. Find the Company Short Name. (1/2) — Enter the UKG Ready domain. Find the Company Short Name.

Enter the UKG Ready domain. Find the Company Short Name. (2/2) — Enter the UKG Ready domain. Find the Company Short Name.

Find Your UKG Ready API Key

Use the existing API key when one is already in use, or generate a new one if needed.

Go to Settings > Global Setup > Company Setup > Login Config.

Scroll to the API Keys section.

IMPORTANT

If an API key already exists and is being used by another integration, do not generate a new one. Copy the existing key. Generating a replacement could affect other integrations.

If no API key exists, select Generate and confirm Yes.
Select the eye icon to reveal the key, copy it, and enter it in your secure Clarity connection link.

Locate the existing API key or generate one only when needed.

Create Integration Access

Create a security profile and service account with the access needed for the connection.

Go to Settings > Profiles/Policies > Security and create a New Security Profile.

Give the profile the required access below.

Global

Global Setup: View Company EINs, Cost Center Definitions, and Leave of Absence Custom Fields Definitions
Object Lists: View Company EINs, Cost Centers, Leave of Absence Categories, and Pay Period Profile

Payroll

Create/Edit Payroll and View/Edit/Add Payroll Adjustment
Payroll Prep Process

HR

View Employee Base Compensation, Benefit Management (Plans), Cost Centers, and Total Compensation
Leave of Absence Management: Manage Requests

Modules

REST API Resources: Employee Demographics, Employee HR Custom Fields, Employee Profiles, Employee Pay Information, and Employees

Create a dedicated security profile and assign only the required access.

Go to Settings > Global Setup > Company Setup > Edit Tabs. Add Service Accounts to the available windows and save.
Return to Login Config and add a new Service Account.
Enter the service account username and password, select the security profile you created, and set Account Access to All Company Employees.

Create the service account. Set Account Access to All Company Employees. (2/3) — Create the service account. Set Account Access to All Company Employees.

Create the service account. Set Account Access to All Company Employees. (3/3) — Create the service account. Set Account Access to All Company Employees.

KEEP THESE CREDENTIALS HANDY

You will use the service account username and password in the final connection step.

Connect UKG Ready to Clarity

Enter the details you gathered and complete the secure connection.

Return to your secure Clarity connection link.
Enter your UKG Ready service account username and password when prompted.
Select Connect.

Enter the service account credentials created in UKG Ready. (1/2) — Enter the service account credentials created in UKG Ready.

You’re Connected!

Once the connection is established, Clarity can begin securely syncing the data needed for your benefits administration.

Screenshot: Connect UKG Ready to Clarity (2/2)

QUICK CHECK BEFORE YOU FINISH

Confirm that you used the correct domain, Company Short Name, existing or newly generated API key, and the dedicated service account tied to the new security profile.