Retrieving UKG Pro Core API Credentials

During the setup of the UKG New Hire integration, it will be necessary for the end user to gather some initial data from UKG and pass it along to ClearCompany.  Below are the steps necessary to gather the API Credentials that will be used to send data from ClearCompany into UKG:

In this article:
Gathering UKG API Information
Create UKG API Username and Password
Permissions Required in UKG
Sharing Information with Support

Gathering UKG Information

1. Login to your UKG Pro environment using an administrator account

Gather API Information

1. Go to Menu -> System Configuration
2. Security -> Web Services
3. Collect the following information:
4. API URL: Take the "Business Intelligence web service endpoint" and take only the first part of the url (i.e. http://Servicet.ultipro.com/services/BIDataService -> http://Servicet.ultipro.com)
5. Customer API Key

Create the API Username and Password

1. Go to Menu -> System Configuration -> Security -> Service Account Administration.
2. If you already have an API Username, please collect the Username, Password, and User API Key. Please note that passwords for service accounts can only be viewed once, so they must be reset to retrieve a password if it has not been recorded, which will disrupt any connections using the account. Because of this, each service account should only be used for one connection, so only choose this option if you've previously created the service account for this integration. You may need to create multiple service accounts for ClearCompany if you are connecting both System of Record and New Hire Export integrations. 
3. If you would like to create a new API Username and Password, press ADD. Once the new account is created with the necessary permissions, you will have to retrieve the Username, Password, and User API Key for that account specifically. 
   

The following Permissions will be required. Please select Add, View, and Edit for the following (if available):

Employee Person	Employee Address	Employee Contacts	Employee Job	Employee compensation
Employee New Hire	Employee Canadian New Hire	Employee Global New Hire	Employee User-Defined Fields	Employee Employment Information
Employee Phone Information	Employee Termination	Employee SUI Tax Rate	Employee Process Hire	Employee Onboarding Documents
Employee Export	Payroll Integration	Personnel Integration	Talent Integration	Tax Integration
Time Integration	Deduction Integration	Launch Integration	Custom Integration	Employee Direct Deposit
Global Employee Direct Deposit	Employee Job History Details	Employee Person Details	Employee Compensation Details

Sharing information with Support

Once all this information is gathered, please pass it along in a secure manner to your ClearCompany agent assisting you with the setup.  The best option would be to utilize the secure file transfer center located under Tools -> Setup -> Secure File Center.  More information on the Secure File Transfer Center can be found here:

https://clearco.zendesk.com/hc/en-us/articles/360038318154-Secure-File-Center