IMPORTANT NOTE

Effective January 1, 2023, UKG Pro (UltiPro) and UKG Ready (Kronos) are NOT available integrations for deverus partners who are not already partnered with UKG.

Overview

The UKG Ready (formerly Kronos) integration with deverus facilitates seamless background check processing within UKG Ready’s Applicant or Employee module. The clients consultant should have a configuration guide to follow, and the CRA can up the Integration Manager (IM) account, or they can opt for deverus to handle the entire configuration for an associated fee.

Timeline

Estimated Time to Configure:

Configuration by UKG Ready Consultant: Varies based on consultant’s availability
IM Account Configuration by CRA: 1-2 business days after credentials are received
Configuration by deverus: 2 weeks total

Expected Go-Live Timeline:

Once all requirements are met, the typical go-live time is approximately 2 weeks, including testing and validation.

Integration Connection Pricing

1. Self-Service Integration (No Cost)

We continue to provide comprehensive resources for self-implementation:

Detailed integration documentation
Step-by-step implementation guides
Access to our knowledge base

These resources remain completely free and are sufficient for most standard integration scenarios.

2. Premium 14-Day Support Package ($2,250)

For situations requiring direct assistance from our team, we offer a 14-day support package:

Direct access to our integration specialists
Technical troubleshooting and guidance
Implementation assistance
Configuration help
Testing support

Integration Requirements

Prerequisites for Setup

Partnership with UKG Ready: Required
UKG Ready Consultant Required: Yes
deverus: Integration Manager (IM) configuration (completed by CRA, or deverus with SOW)
SwiftHire Mobile: Required

Configuration Options

Option 1: Consultant Completes UKG Ready Configuration, CRA Configures IM

Required Information for Setup

Consultant must provide the following details to the CRA:

UKG Ready API Credentials
- API Username
- Company Short Name
- API Password
- System ID for Applicant or Employee report
- Base Link
- Module (either 'Applicant' or 'Employee')
- API Key
- Report Custom Field Index
- Status Custom Field Index
- Message Custom Field Index
- Package Custom Field Index

Understanding Custom Field Indexes

The consultant should provide the Custom Field system index (e.g., "Extra Field 1"), but please note:

UKG system indexes start at 1
API indexes start at 0

(e.g.) If the consultant says "Custom Field Value 1," you will enter 0 into Integration Manager. If you prefer to confirm values directly, see the API method below.

Optional: Use API to Retrieve Field Indexes You can retrieve the correct API indexes by running the following API calls in Postman or your preferred API tool:

Step 1: Get Bearer Token

curl --location 'https://secure4.saashr.com/ta/rest/v1/login' \
--header 'Content-Type: application/json' \
--header 'Api-Key: [API_KEY]' \
--data-raw '{
  "credentials": {
    "username": "[API_USERNAME]",
    "password": "[API_PASSWORD]",
    "company": "[COMPANY_ID]"
  }
}'

This returns a Bearer Token in the response, which you will use to authenticate your next two GET requests.

A. If Using Applicant Module

Step 2: Pull the Saved Report

curl --location 'https://secure3.saashr.com/ta/rest/v1/report/saved/[REPORT_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/xml'

This lists applicants tied to the saved report. Use an Applicant ID from the response for the next step.

Step 3: Get the Applicant’s Custom Fields

curl --location 'https://secure3.saashr.com/ta/rest/v2/companies/[COMPANY_ID]/applicants/[APPLICANT_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/json'

Look for the "applicant_custom_fields" section in the response.

Plug these values into IM as the Report/Status/Message/Package Custom Field Index values.

B. If Using Employee Module

Step 2: Pull the Saved Report

curl --location 'https://secure3.saashr.com/ta/rest/v1/report/saved/[REPORT_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/xml'

Step 3: Get the Employee’s Custom Fields

curl --location 'https://secure4.saashr.com/ta/rest/v2/companies/[COMPANY_ID]/employees/[EMPLOYEE_ID]' \
--header 'Authentication: Bearer [BEARER_TOKEN]' \
--header 'Accept: application/json'

Look for the "account_extra_fields" section in the response.

Plug these values into IM as the Report/Status/Message/Package Custom Field Index values.

Project Steps

UKG Ready Consultant completes the configuration within the Applicant or Employee module according to their Configuration Guide.
UKG Ready Consultant provides all required credentials and data points to CRA.
UKG Ready Consultant prepares a test applicant in Submitted status.
CRA configures the account in Integration Manager using the provided credentials and maps the Locations and Packages.
Roundtrip testing.

Option 2: deverus Completes Full Configuration

deverus handles the project from start to finish, including configuring API credentials, mapping, API calls, and roundtrip testing.
Full configuration takes approximately 2 weeks, including testing.
Subject to the Premium 14-Day Support Package ($2,250) for configuration and testing.

Integration Manager (IM) Configuration Steps

Steps for CRA

Note: Please wait to configure the account in Integration Manager until you have all of the required API credentials.

Login to deverus -> Integration tab -> Home
Select the UKG Ready (Kronos) tile
Select "Configure Existing Client"
Type in the name of the top/parent client account and select it
Choose the Send Results option:
- Report Link with Login (the result URL in UKG Ready for the completed report will prompt the user to enter their deverus login credentials to view report)
- Report Link without Login (the result URL in UKG Ready for the completed report will bring the user directly to a copy of the report)
Toggle SwiftHire to On and ensure it is properly configured for the account and user(s)
Click Next
Enter UKG Ready API credentials provided by the consultant into corresponding IM fields (refer back to Understanding Custom Field Indexes):
- API Username ("Account ID")
- Company Short Name ("Company ID")
- API Password
- System ID for Applicant or Employee report ("Report ID")
- Base Link ("Host Name" in the format of secure5.saashr.com)
- Module (either 'Applicant' or 'Employee')
- API Key
- Report Custom Field Index
- Status Custom Field Index
- Message Custom Field Index
- Package Custom Field Index
Click 'Save Settings'

Map Package(s)

Locate the account you just configured in IM
Navigate to "Map Fields"
Enter the name of the package as the Integrations Partner Package ID
Save Mappings

Map Location(s)

Locate the account you just configured in IM
Navigate to "Map Fields"
Enter the name of each location/branch as the Integrations Partner Location ID
Save Mappings

Test the Integration

Ensure the consultant has prepared a test applicant/employee in Submitted status.
Allow 1-2 hours for the polling process to pick up the test order. You can log into deverus as the client to confirm a SwiftHire invitation has been created. Have the consultant confirm they see 'Pending Candidate' status.
Complete the SH invite as the applicant by logging in as the client and clicking on the Waiting status. Have the consultant confirm they see 'Pending' status.
Complete the report from the Admin module, and have the consultant confirm they see 'Complete' status along with the report URL.

Special Notes & Considerations

The UKG Ready Consultant should be able to provide the Custom Field Index values you will need to plug into IM.
You can view integration logs within the Activity tab of the report to confirm when a status update was successful or failed and with what error code, which will help you troubleshoot.