To connect your UKG Ready account, you must create a service account for the application you are connecting to. The username and password used will be of the service account created.

If you need access to Benefits data, follow the instructions below as well as the instructions listed HERE to add an administrator to support the benefits scope.

Before you start

Before you begin, make sure you are using the UKG Ready product. For UKG Pro users, see the instructions HERE.

If your team uses this application to sync Organization data only

• For Organization Only data (Individual, Employer, and Directory endpoints) all fields with a ✅ in the instructions below are required.

If your team uses this application to sync Organization and Payroll data

• For Pay and Organization data, all listed fields in the instructions below are required.

Instructions

1. Log in to UKG.

2. Copy and paste the Web Service URL from your browser URL into Finch Connect. In this example it would be partner.saashr.com.

3. Create a security profile for your service account by navigating to Settings > Profiles/Policies > Security.

4. Don't forget to provide a Name.

5. In the Global tab under Security Items please check off the following fields for view access:

• ✅ Address (used for addresses for our /individual and /employment scopes)
• ✅ Company EINs (required permission to support all roles) 
• ✅ Cost Center Definitions (used for departments for our /company and /employment scopes)
• ✅ Employee Types (used for the employement.subtype field for our /employment scope)

6. In the Payroll tab under Security Items please check off the following fields for view access. These permissions are for our /payments and /pay-statements scopes.

7. In the HR tab under Security Items please check off the following fields for view access:

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

8. Navigate to Rest API Resources. Select Employee Demographics, Employee Profiles, and  Employees

• ✅ Employee Demographics (used for /individual scope)
• Employee Pay Information (used for /payments and /pay-statements scopes)
• ✅ Employee Profiles (used for /directory, /individual and /employment scopes)
• Employee HR Custom Fields (used if custom payroll reporting/fields are needed)
• Employee Tax Information (used for /payments and /pay-statements scopes)
• ✅ Employees (required for all scopes, and used for our/directory, /individual and /employment scopes)

9. In the Report tab under Security Items please check off the following fields for view access:

• ✅ Export Reports and CSV/Text (required for all scopes, used to get Legal Name and EIN for our /company scope, and for the employment.subtype for our /employment scope)

10. Next, you'll need to add a service account tab. Navigate to Global Setup / Company Setup, select Edit Tabs and then drag and drop the Service Accounts panel to your Login Config tab.

11. Now you'll be able to create a service account. Navigate back to Company Setup > Login Config.

12. Scroll down and select ADD SERVICE ACCOUNT

13. Create a Username and Password that meets the security requirements. You'll use these in Finch Connect. Then, select the Security Profile you created in Step 3 and set Account Group(s) to All Company Employees. Finally, click Save. 

14. After you click Save, scroll to the bottom of the Company Setup page. You will see a section called API Keys. Copy the value from the REST API Key field and paste this into Finch Connect. 

If your team uses this application to update deductions and contributions

If you need access to Benefits data, follow the instructions above as well as the instructions listed HERE to add an administrator to support the benefits scope.