Skip to main content
Ensure you have Admin privileges in UKG Pro to create Service Accounts and access Web Services configuration.

​
Create a Service Account

A Service Account is required to authenticate API requests to UKG Pro.

1

Log in to UKG Pro

Sign in to your UKG Pro account with administrator credentials.

2

Navigate to Service Account Administration

Go to Sidebar Menu > System Configuration > Security > Service Account Administration.

3

Create a new Service Account

Click the Add button to create a new service account.

  • Username: Enter a descriptive name (e.g., StackOneIntegration)
  • E-mail: Add a valid email
4

Configure Web Service Permissions

Enables actions: Create Organization Level, Create PTO Plan, Get Compensation Details By Employee, Get Employee Contact Details, Get Employee Last Pay Statement, Get Employee Pay Statements, Get Employee Security User Details, Get International Employee Details, Get Job Configuration, Get Location Configuration, Get PTO Plan, Get Pay Register, Get Person Details, Get Security Roles, Get User Details, List Business Structure Changes, List Company Details, List Compensation Details, List Dependent Deductions, List Direct Deposits, List Earnings Configurations, List Earnings History, List Employee COBRA Details, List Employee Changes By Date, List Employee Changes By Employee ID, List Employee Contacts, List Employee Deductions, List Employee Job History Details, List Employee Multiple Phone Numbers, List Employee PTO Plans, List Employee Positions, List Employee Supervisor Details, List Global Employee Bank Accounts, List Global Localization Elements, List International Employees, List Job Configurations, List Job Groups, List Location Configurations, List Open Enrollment Employee Deductions, List Organization Levels, List PTO Plans, List Pay Group Pay Periods, List Payroll Deductions History, List Person Details, Update PTO Plan

In the permissions table, select all of the following scopes by checking their corresponding checkboxes:

5

Save and record credentials

Click Save. The system will generate a password for the service account.

  • ⚠️ Important: Copy and securely store the generated password immediately. It will only be displayed once.
  • If you lose the password, you’ll need to reset it from the Service Account Administration page.

​
Find Your Customer API Key

The Customer API Key is required for all API authentication.

1

Navigate to Service Account page

Go to Sidebar Menu > System Configuration > Security > Service Account Administration.

2

Locate the Customer API Key

The Customer API Key is displayed at the top of the Service Account Administration page.

  • The API Key is typically a short alphanumeric string (often uppercase)
  • Example format: VWUIA or similar
  • Copy this value for use in the integration setup

​
Find Your Web Services Domain

You need to identify your UKG Pro Web Services domain and subdomain.

1

Navigate to Web Services

Go to Sidebar Menu > System Configuration > Security > Web Services.

2

Identify the domain from any endpoint

Look at any Web Services endpoint URL displayed on the page.

  • Example URL: https://service2.ultipro.com/services/...
  • Web Service Domain: ultipro.com (the main domain)
  • Web Service Subdomain: service2 (the subdomain prefix)

​
Troubleshooting

Common issues and how to resolve them.

1

Error: 401 Unauthorized

This error indicates authentication failure.

  • Verify the Service Account username is correct (case-sensitive)
  • Confirm the password is correct
  • Check that the Customer API Key is correct
  • Ensure the Service Account status is Active
2

Error: 403 Forbidden

This error indicates the Service Account lacks required permissions.

  • Go to Service Account Administration
  • Edit the Service Account
  • Enable the required API access permissions
  • Save and retry the connection
3

Error: Connection timeout or host not found

This error indicates incorrect domain configuration.

  • Double-check the Web Service Domain (e.g., ultipro.com)
  • Verify the Web Service Subdomain (e.g., service2)
  • Ensure your network allows outbound HTTPS connections to UKG Pro
4

Service Account password expired

Service Account passwords may expire based on your organization’s security policies.

  • Go to Service Account Administration
  • Select the Service Account
  • Click Reset Password
  • Update the password in your StackOne connection

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • UKG Pro Service Account User name
  • UKG Pro Service Account Password
  • UKG Pro Customer API Key
  • UKG Pro Web Service domain
  • UKG Pro Web Service subdomain
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.