UKG Ready API

To connect your UKG Ready account, you must create a service account with the all the proper permissions. The username and password used will be of the service account created.

​

Step by step guide

1. Select UKG Ready from the list of providers in Finch Connect

2. Get the web service url To get the Web Service URL look at the url in your browser. In this example it would be partner.saashr.com.

3. Create a security profile for your service account.
   

   1. Go to Settings → Profiles/Policies → Security

   2. Remember to provide a name.

   3. In your Global tab under Security Items have these fields checked off for view access:

      • Address and Company EINs is used EIN for our /company scope.
      • Cost Center Definitions is used for departments for our /company and /employment scopes.
      • Employee Types is used for our employement.subtype field for our /employment scope.

   4. In your Payroll Tab under Security Items have these fields checked off for view access. These permissions are for our /payments and /pay-statements scopes.

   5. In your HR tab under Security Items have these fields checked off for view access:

      • Employee Information is used for /directory, /individual and /employment scopes.
      • Base Compensation used for /employment scope.
      • Cost Centers is used for departments for our /company, /directory and /employment scopes.
      • Jobs is used for our /employment scope.
      • Social Security is used for our /individual scope.
      • Total Compensation is used for our /employment scope.

   6. In your Modules tab under Security Items have these fields checked off for view access

      • Employee Demographics is used for /individual scope.
      • Employee Pay Information is used for /payments and /pay-statements scopes.
      • Employee Profiles is used for /directory, /individual and /employment scopes.
      • Employee Tax Information is used for /payments and /pay-statements scopes.
      • Employees is used for our/directory, /individual and /employment scopes. This is required for all scopes.

   7. In your Report tab under Security Items have these fields checked off for view access

      • Reports are used to get Legal Name and EIN for our /company scope. This is required for all scopes.
      • Additionally for employment.subtype for our /employment scope.

4. Add service account tab

   Login to UKG Ready, navigate to Global Setup / Company Setup, select Edit Tabs and add the Service Accounts panel to your Login Config tab dragging the panel.

5. Create a service account

   1. Navigate back to Company Setup and to the Login Config tab

   2. Scroll down and select ADD SERVICE ACCOUNT

   3. Provide username/password, it can be anything as long as it meets the security requirements. Security profile will the security profile that was created in the previous step. Account group should be “All Company Employees”. Then click save. The username and password will be used during connect.

6. Get API Key

   To get the API Key, navigate to Global Setup / Company Setup then Login Config tab. Scroll down to the API Keys panel. You do not need to generate if one already exists. Press generate if it does not exist, then reveal and copy.

7. Get Company Short Name

   To get Company Short Name, navigate to Global Setup / Company Setup then Company Info tab.

8. Enter the information into Finch Connect, click the checkbox saying that you have completed all the steps above and then click Connect.