You will gather your UKG Pro API key, create a service account, confirm the required access, and enter the information in the secure Clarity connection window.
Find Your Customer API Key
Locate the Customer API Key in UKG Pro and enter it in the secure Clarity connection window.
- Sign in to UKG Pro and search for “Service Account Administration.”
- Copy the Customer API Key shown near the top of the page.
- Open your secure Clarity connection link and enter the Customer API Key when prompted.
Create Your Service Account
Create the UKG Pro service account that Clarity will use for the connection.
- Return to Service Account Administration and select + Add.
- Enter the username and email for your UKG Pro administrator account. Save the username for the final connection step.
Confirm the Required Access
Give the service account the permissions needed for your Clarity connection, then save the generated password.
In the Web Service section, enable View Employee Person Details. This permission is required.
Add any other permissions required for your connection.
- Employee Pay Statement
- Employee Employment Information
- PTO Plan Integration
- Company Configuration Integration
- Payroll Integration
- Personnel Integration
- Employee Job History Details
- Employee Compensation Details
Select Save. UKG Pro will generate a new password. Copy and store it securely.
Connect UKG Pro to Clarity
Enter your service account credentials and UKG Web Services information to complete the secure connection.
- In the secure Clarity connection window, enter your service account username and generated password.
- In UKG Pro, search for “Web Services.”
- From one of the Web Services URLs, identify the subdomain. It is the text after
https://and before the first dot. Example:service4. - Identify the top-level domain from the same URL. Example:
ultipro.com. - Enter both values when prompted and select Connect.
https://service4.ultipro.com/XXXABCS.Login, enter service4 as the subdomain and ultipro.com as the domain.