> For the complete documentation index, see [llms.txt](https://docs.sprinto.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinto.com/integrations/overview/ukg-ready-integration.md).

# UKG Ready Integration

Integrate UKG Ready with Sprinto to automatically sync employee information and employment status data. This integration helps automate employee lifecycle monitoring by keeping onboarding, offboarding, reporting structures, and workforce records up to date within Sprinto.

Sprinto uses the synced employee data to automate compliance controls and continuously monitor employee-related checks.

#### Sprinto checks for UKG Ready <a href="#sprinto-checks-for-ukg-ready" id="sprinto-checks-for-ukg-ready"></a>

Here's a list of Sprinto checks available for UKG Ready integration, along with reference procedures on how to fix them:

| Sprinto check                                    | Description                                                                                                                                         | Reference procedure                                                                                   |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| Staff role should be assigned                    | All in-scope staff members must have an assigned staff role.                                                                                        | [How to fix](/data-library/people/dashboard-actions/manage-staff-and-organisational-configuration.md) |
| Reporting manager should be assigned             | <p>All in-scope staff members should have an assigned reporting manager. <br><br>Note: Top management roles like CEO, CTO, etc. are exceptions.</p> | [How to fix](/data-library/people/dashboard-actions/manage-staff-and-organisational-configuration.md) |
| Date of joining for new staff should be provided | Define the joining date for all newly onboarded staff members.                                                                                      | [How to fix](/data-library/people/dashboard-actions/manage-staff-and-organisational-configuration.md) |

### Prerequisites

Before connecting UKG Ready to Sprinto, ensure that:

* You have administrator access to UKG Ready.
* You have your UKG Ready domain.
* You have your company short name.
* You have generated an API key.
* You have created a dedicated service account for Sprinto.
* You have the service account username and password available.

### Find your UKG Ready credentials

Before connecting UKG Ready to Sprinto, gather the following information from your UKG Ready account:

* UKG Ready domain
* Company short name
* API key
* Service account username
* Service account password

For detailed instructions on locating these values and creating the required service account, refer to the [UKG Ready setup guide](https://help.merge.dev/articles/5696149-ukg-ready-how-do-i-link-my-account).

This guide includes step-by-step instructions for:

* Finding your UKG Ready domain
* Finding your company short name
* Generating an API key
* Creating and configuring a service account
* Assigning the required permissions to the service account

#### Required permissions

Assign the following permissions to the service account used for the integration:

**Modules → Rest API Resources**

* Employees - View
* Employee Profiles - View
* Employees (Changed) - View
* Employees (me) - View

### Data synced by Sprinto

Sprinto syncs the following information from UKG Ready:

* Employee ID
* First name
* Last name
* Full name
* Email address
* Start date
* Termination date
* Employment status
* Employment type
* Role
* Reporting manager email

### Connect UKG Ready to Sprinto

1. Log in to Sprinto.
2. Navigate to **Settings > Integrations**.
3. In the **All** tab, search for **UKG Ready**.
4. Click **Connect** next to UKG Ready.

<figure><img src="/files/6L07YNdimoD21tLuMCy4" alt="" width="563"><figcaption></figcaption></figure>

5. Review the permissions required and the data that Sprinto will access.
6. Click **Next**.

<figure><img src="/files/eO63wVp4kHfGdWoj6yrr" alt="" width="375"><figcaption></figcaption></figure>

#### Review integration requirements

Before proceeding, ensure you have the following information available:

* UKG Ready domain
* Company short name
* API key

7. Select the **I have the company domain, company short name and API key handy** checkbox.
8. Click **Connect to UKG Ready**.

<figure><img src="/files/o6XvZ6aRb2uiHxKJzy2i" alt="" width="375"><figcaption></figcaption></figure>

#### Authorise the connection

1. In the UKG Ready authorisation window, click **I am an admin**.
2. Review the permissions that Sprinto requires access to.
3. Click **Next**.

<figure><img src="/files/LrIJxSS1HndlPY9PuGHk" alt="" width="328"><figcaption></figcaption></figure>

#### Enter your UKG Ready domain

1. Enter your UKG Ready domain.
2. Click **Next**.

<figure><img src="/files/imvAJgJRugQCPEdcCD8o" alt="" width="329"><figcaption></figcaption></figure>

For example, if your login URL is:

`https://secure.saashr.com/ta/Default.login`

Enter only:

`secure.saashr`

Do not enter the full URL.

#### Enter your company short name

1. Enter your UKG Ready company short name.
2. Click **Next**.

<figure><img src="/files/SQVMLv7QCfJ0d6nT2KCo" alt="" width="327"><figcaption></figcaption></figure>

#### Enter your API key

1. Enter your UKG Ready API key.
2. Click **Next**.

<figure><img src="/files/KCzkZnr8NODaDW5krAsD" alt="" width="326"><figcaption></figcaption></figure>

#### Enter service account credentials

1. Enter the username of the UKG Ready service account.
2. Enter the password of the service account.
3. Click **Next**.

<figure><img src="/files/KBcrPCaaV8px0at8ep8b" alt="" width="331"><figcaption></figcaption></figure>

Sprinto validates the connection and completes the integration.

### Post-connection behaviour

After the integration is connected:

* Sprinto performs an initial sync of employee records from UKG Ready.
* Active employees are automatically imported into Sprinto.
* Employee onboarding status is continuously monitored.
* Employee offboarding events are automatically detected.
* Reporting manager relationships are synced and mapped.
* Employment status changes are reflected in Sprinto during subsequent syncs.
* Team and organisational data are updated as changes occur in UKG Ready.
* Applicable employee-related controls and compliance checks begin collecting evidence automatically.

Depending on the size of your workforce, the initial synchronisation may take several minutes to complete.

### APIs used

Sprinto uses Merge to connect with UKG Ready and accesses the following APIs:

* `GET /api/hris/v1/employees`
* `GET /api/hris/v1/employments`
* `GET /api/hris/v1/groups`
* `GET /api/hris/v1/passthrough`

### Troubleshooting

#### Unable to connect UKG Ready

Verify that:

* You are using a UKG Ready administrator account.
* The company domain is entered correctly.
* The company short name is entered correctly.
* The API key is valid.
* The service account credentials are correct.

#### Employee records are not syncing

Verify that:

* The service account has the required API permissions.
* The service account is active.
* Employee records exist in UKG Ready.
* The initial synchronisation has completed.

#### Authentication failures

Verify that:

* The service account password has not expired.
* The API key is active.
* The domain and company short name match your UKG Ready instance.

If the issue persists, reconnect the integration and retry the synchronisation.

### **Support** <a href="#support" id="support"></a>

If you encounter any issues or need assistance with your integration, contact the Sprinto support team at <support@sprinto.com>.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sprinto.com/integrations/overview/ukg-ready-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.