--- title: "HRIS API Integration: How to integrate with UKG Ready or Pro" description: How to integrate UKG with Pequity --- [Skip to content](https://helpcenter.pequity.com/support/hris-integration-ukg#main-content) English Show submenu for translations [More support](https://helpcenter.pequity.com/support/kb-tickets/new?hsLang=en) ![Logo (1)](https://helpcenter.pequity.com/hs-fs/hubfs/Logo%20(1).png?width=202&height=50&name=Logo%20(1).png) - [Pequity](https://pequity.com/) - [Platform](https://pequity.com/solutions) - [Blog](https://blog.pequity.com/) - [Login](https://pequity.app/login) - [Get a demo](https://pequity.com/contact) Open main navigation Close main navigation - [Pequity](https://pequity.com/) - [Platform](https://pequity.com/solutions) - [Blog](https://blog.pequity.com/) - [Login](https://pequity.app/login) - [Get a demo](https://pequity.com/contact) - English Show submenu for translations - [More support](https://helpcenter.pequity.com/support/kb-tickets/new) - Contact us Contact us How can we help you? - There are no suggestions because the search field is empty. 1. [Support Center](https://helpcenter.pequity.com/support?hsLang=en) 2. [Getting Started with Pequity](https://helpcenter.pequity.com/support/getting-started-with-pequity?hsLang=en) 3. [Integrations & Data Management](https://helpcenter.pequity.com/support/getting-started-with-pequity?hsLang=en#integrations-data-management) # HRIS API Integration: How to integrate with UKG Ready or Pro ## This guide outlines how to successfully connect your UKG Ready or UKG Pro account using the API integration features provided by each platform. You’ll find step-by-step instructions to collect your required credentials, configure the correct access settings, and complete the linking flow. #### ⚠️ **Prerequisites**: You must be an Administrator in your company’s UKG Ready or Pro instance, or have access permissions shared with you. ### **🔁 UKG Ready Integration** #### **Overview** #### To authenticate your UKG Ready account, you’ll need: - **Domain** - **Company Short Name** - **API Key** - **User ID** - **Password** #### **Step-by-Step Instructions** #### **✅ Step 1: Enter Your Domain** From your login URL (e.g., acme.com/ta/Default.login), extract the domain—acme.com—and enter it into the linking flow. #### **✅ Step 2: Retrieve Your Company Short Name** 1. Login to UKG Ready. 2. Open the left menu → go to **Settings** → **Global Setup** → **Company Setup**. 3. Open **Company Info** and scroll to **Company Address**. 4. Copy your **Company Short Name** and paste it in the linking flow. #### **✅ Step 3: Retrieve or Create Your API Key** 1. Go to **Login Config** within Company Setup. 2. Scroll to **API Keys**. Click the 👁️ icon to reveal the key. \*If no key exists, click **Generate** (⚠️ avoid this if other integrations rely on the existing key). 3. Copy and paste the API Key in the linking flow. #### **✅ Step 4: Create a Security Profile** 1. Navigate to **Settings** → **Profiles/Policies** → **Security** → **New Security Profile**. 2. Ensure the following permissions are enabled: **HR Tab**: - Employee Management → Base Compensation → **View** - Benefit Management (Plans) → **View** - Cost Centers, Total Compensation, HR Custom Values → **View** **Leave of Absence Management**: - Manage Requests → **Enabled** (if applicable) **Modules Tab** (if applicable): - Rest API Resources → Employee Demographics, HR Custom Fields, Profiles, Pay Information, Employees → **Enabled** **Global Tab**: - Global Setup → Company EINs, Cost Center Definitions, Leave Custom Fields Definitions → **View** - Object Lists → Company EINs, Cost Centers, Leave Categories, Pay Period Profiles → **View** **Payroll Tab**: - Payroll → Create/Edit Payroll, Payroll Prep Process, Payroll Adjustments → **View/Edit/Add** #### **✅ Step 5: Create a Service Account** 1. Go to **Settings** → **Global Setup** → **Company Setup** → **Edit Tabs**. 2. Drag **Service Accounts** to the **Top section**, then click **Save**. 3. Click **Add Service Account**, provide: - Username & password - The Security Profile you created - Account Group → **All Company Employees** **✅ Step 6: Complete the Linking Flow** Use the Service Account’s **User ID** and **Password** to finalize the connection   ### **🔁 UKG Pro Integration** #### **Overview** To integrate with UKG Pro, you’ll need: #### **Customer API Key** - **Service Account Username** - **Service Account Password** - **Web Service Domain** #### **Step-by-Step Instructions** #### **✅ Step 1: Get Your Customer API Key** 1. Log in to UKG Pro. 2. Search **Service Account Administration**. 3. Copy the **Customer API Key** and paste it in the linking flow. #### **✅ Step 2: Create a Service Account** 1. On the same **Service Account Administration** page, click **+ Add**. 2. Enter the **username and email** of your admin user. - Scroll to the **Web Service** section and enable: **View Employee Person Details** (mandatory) 3. Click **Save**. A password will be generated—store it securely. Depending on your needs, also enable: \- Employee Pay Statement \- Employment Information \- PTO Plan Integration \- Company Configuration Integration \- Payroll/Personnel Integration \- Job History \- Compensation Details 4. Enter the **Service Account username and password** into the linking flow #### **✅ Step 3: Find Your Web Service Domain** 1. Search for **Web Services**. 2. Copy any available URL (e.g., http://Servicet.ultipro.com/services/BIDataService). 3. Paste this domain into the linking flow to complete the setup. #### **✅ Final Notes** - Double-check that all credentials are accurate before submitting. - All permissions listed are based on typical use cases—adjust as needed based on your specific integration goals. - If issues arise during setup, contact your UKG system administrator or support team. - [Getting Started with Pequity](https://helpcenter.pequity.com/support/getting-started-with-pequity?hsLang=en#main-content) - [Pequity Setup & Company Admin Onboarding](https://helpcenter.pequity.com/support/getting-started-with-pequity?hsLang=en#pequity-setup-company-admin-onboarding) - [Personal Settings](https://helpcenter.pequity.com/support/getting-started-with-pequity?hsLang=en#personal-settings) - [Integrations & Data Management](https://helpcenter.pequity.com/support/getting-started-with-pequity?hsLang=en#integrations-data-management) - [ADP Lyric HCM Integrated Pequity](https://helpcenter.pequity.com/support/adp-lyric-hcm-integrated-pequity?hsLang=en) - [Managing Your Team in Pequity](https://helpcenter.pequity.com/support/managing-your-team-in-pequity?hsLang=en#main-content) - [General User Access](https://helpcenter.pequity.com/support/managing-your-team-in-pequity?hsLang=en#general-user-access) - [Single Sign-On (SSO) Integration](https://helpcenter.pequity.com/support/managing-your-team-in-pequity?hsLang=en#single-sign-on-sso-integration) - [People Manager Access](https://helpcenter.pequity.com/support/managing-your-team-in-pequity?hsLang=en#people-manager-access) - [Pequity Features & Workflows](https://helpcenter.pequity.com/support/pequity-features-workflows?hsLang=en#main-content) - [Pequity Comp Cycles](https://helpcenter.pequity.com/support/pequity-features-workflows?hsLang=en#pequity-comp-cycles) - [Pequity Ranges Tool](https://helpcenter.pequity.com/support/pequity-features-workflows?hsLang=en#pequity-ranges-tool) - [Pequity People Tool](https://helpcenter.pequity.com/support/pequity-features-workflows?hsLang=en#pequity-people-tool) - [Pequity Approvals Tool](https://helpcenter.pequity.com/support/pequity-features-workflows?hsLang=en#pequity-approvals-tool) - [Pequity Best Practices](https://helpcenter.pequity.com/support/pequity-best-practices?hsLang=en) - [Security & Compliance in Pequity](https://helpcenter.pequity.com/support/security-compliance-in-pequity?hsLang=en) - [Proactive Support & Troubleshooting](https://helpcenter.pequity.com/support/proactive-support-troubleshooting?hsLang=en) - [Pequity Updates & Insights](https://helpcenter.pequity.com/support/pequity-updates-insights?hsLang=en) - [Pequity University](https://helpcenter.pequity.com/support/pequity-university?hsLang=en#main-content) - [Comp 101](https://helpcenter.pequity.com/support/pequity-university?hsLang=en#comp-101) - [Reward Letters](https://helpcenter.pequity.com/support/reward-letters?hsLang=en) [![Pequity](https://helpcenter.pequity.com/hubfs/Pequity%20an%20adp%20company%20final%5B96%5D%20(1).svg "Pequity")](http://pequity.com) 1 ADP Boulevard Roseland, NJ 07068 Copyright © 2026 Pequity, an ADP Company