UKG Pro DSR integration

This guide walks you through everything you need to connect UKG Pro to MineOS so employee data requests (like "send me a copy of my data") can be handled automatically. You don't need any technical background — just access to your UKG Pro admin settings and a few minutes.

What this integration does

When a privacy request comes in, MineOS identifies the employee by their email address and checks it against your UKG Pro directory. Depending on the type of request:

• Access requests— MineOS looks up the matching employee and confirms whether they were found, returning the identifying details it was able to retrieve.

What you'll need before setup

You'll need someone with System Administrator rights in UKG Pro. If that's not you, ask your UKG Pro administrator to either gather the items below or complete this setup with you.

You will end up needing five pieces of information from UKG Pro:

1. A service account username

2. That service account's password

3. A User API Key

4. A Customer API Key

5. Your organization's hostname

Step 1: Create a service account in UKG Pro

1. A "service account" is a dedicated login used only for this connection, separate from any individual employee's login.
   Log in to UKG Pro
2. Go to System Configuration → Security → Service Account Administration.
3. Create a new service account and give it a clear name (for example, "MineOS Integration").
4. Set a username and password for the account. Note both down — you'll enter them into MineOS later.

Step 2: Grant permissions to the service account

Still on the Service Account Administration page, you'll assign View permission for each Web Service that MineOS needs to read from. As a best practice, only grant access to the services you actually need — nothing more.

Depending on which employee data your organization wants MineOS to be able to retrieve, grant View access to the relevant Web Services, such as:

• Employee Person Details

• Employee Employment Details

• Employee Compensation Details

• Employee Job History

• International Employee Details

• Direct Deposit (US/Canada) or Employee Global Banks (other countries)

• Employee Pay Statements

  Once you save these permissions, the service account can be used to authenticate API requests for exactly those types of data.

Step 3: Find your User API Key

Each service account is issued its own User API Key, which is required (together with the username and password) to authenticate. You'll find this key on the same Service Account Administration page, next to the account you just created.

Step 4: Find your Customer API Key

The Customer API Key is specific to your organization as a whole, not to any one service account. In UKG Pro, this is managed under your company's Web Services security settings — your UKG Pro administrator can locate it from the same Security area used above. This key is sent as a header (`US-Customer-Api-Key`) on every request, alongside your username and password.

Step 5: Find your hostname

UKG Pro doesn't use one shared web address for every customer — each organization has its own. To find yours:

1. Go to System Configuration → Security → Web Services
2. Look at the service endpoint address shown there. It will look something like: `https://servicet.ultipro.com/services/`
3. You only need the domain portion — for example, `servicet.ultipro.com`. You don't need the `https://` or the trailing path.

If you're not sure which value is correct, your UKG Pro representative or system administrator can confirm it.

Step 6: Enter everything into the configuration screen

Once you have all five items, open the connection setup screen in MineOS and enter them into the matching fields:

Save the connection.

Step 7: Confirm the MineOS side

You'll also see a field for your integration instance ID. This identifies which MineOS integration this connection belongs to, and you can find it in your MineOS account under your integration's settings. If you're unsure which value to use, your Mine CSM contact can confirm it for you.

Step 8: Test it

Once everything is saved, run a test if the option is available. A successful test means MineOS can now securely retrieve the relevant employee information from UKG Pro whenever a data request comes in — no manual lookups required on your end.

If you get stuck at any step, your UKG Pro administrator can help you locate the exact screen — menu labels can vary slightly by UKG Pro version.