Skip to main content
This page is for the UKG Pro administrator connecting TruU IDV. When you finish, TruU can look up one employee at a time during verification.
The UKG Pro connector is in Preview: built from UKG’s published Personnel API and tested against it, not yet against a live customer tenant. Run a test lookup before relying on it.

Before you start

  • A UKG Pro administrator who can create web service accounts.
  • Your UKG Pro web services host (it starts with service) and your customer API key.
  • Your Company ID, only if your tenant has more than one company.
  • The UKG employee number of someone to test with.
  • An Owner or Admin seat in TruU IDV.

Restricted account

Create a web service account for TruU with one permission: Personnel Integration: View. Don’t grant Employee Person Details or any Add permission; TruU doesn’t need them.
UKG Pro permissions apply to whole API services, not individual fields. The employee records TruU reads also contain fields like SSN, gender, ethnicity, marital status and health details, and UKG can’t hide them from an account that can read the record. TruU keeps only the fields it needs as soon as a response arrives, and never stores or logs the rest. Because the account can’t be narrowed further, TruU doesn’t show the broad-access warning for UKG Pro.

Set it up

1

Find the host and customer API key

In UKG Pro, the web services host and customer API key are shown with your web services settings (System Configuration → Security → Web Services in most tenants).
2

Open UKG Pro in TruU

Go to Settings → Directory and, under HR system, choose UKG Pro.
3

Enter the details

Enter the Web services host, the Company ID if you have more than one company, and the web service account’s username, password and customer API key.
4

Test and connect

Enter a UKG employee number to test with and choose Test and connect.
5

Review finding people and attributes

By default TruU matches the directory’s Employee Id to the UKG employee number. UKG Pro lists custom attributes from the fields a test lookup returned. Choose Save changes. See Finding people.

Test it

Choose Test lookup on the UKG Pro page. TruU looks one employee up and shows which fields came back as Present or Missing.

How it works

  • Lookup. TruU finds the employee by employee number (or work email), then reads their employment details (status) and demographic details (name, date of birth, address, contact details) in parallel.
  • What’s kept. Only the fields a factor needs for that verification; everything else in the response is dropped on arrival.
  • Sign-in. The web service account’s username and password, plus the customer API key header, over HTTPS. Credentials are stored in a managed secrets service.
If UKG Pro can’t answer, or you disconnect it, checks that read UKG Pro are skipped and verification continues. See When HR is unavailable.

Troubleshooting