> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect UKG Pro with SOAP API — Service Account – StackOne Hub

> Link a UKG Pro account in the StackOne Hub using SOAP API — Service Account. End-user guide to authorize the integration and start using UKG Pro actions.

> [!WARNING]
>
> Ensure you have Admin privileges in UKG Pro to create Service Accounts and access Web Services configuration.

Select Actions to adjust the guideSome actions may require additional configuration in the provider to be accessible. Choose the actions you need and the guide will be updated.

Select all
Clear

ActionScope(s)

Loading actions...No actions match your search.

Dynamic Guide URL

Copy URL

Scopes Selected

<pre role="textbox" aria-readonly="true" tabIndex="0" />

Separator

Copy scopes

## Set up UKG Pro access

A Service Account is a UKG Pro user created for API access. It is recommended over a Web User for API integrations.

**1. Create the Service Account**

Sign in to your UKG Pro account, then open **Sidebar Menu** > **System Configuration** > **Security** > **Service Account Administration**.

<ul>
  <li>Click the **Add** button.</li>
  <li>**Username**: A descriptive name for the service account</li>
  <li>Copy the **Username** across to **Service Account Username**.</li>
  <li>**E-mail**: A valid email address</li>
</ul>

**2. Select the web service permissions**

Enables actions: Find Compensations, Find Contacts, Find Jobs, Find People, Find User Defined Fields, Get Compensation By Employee Identifier, Get Contact By Employee Identifier, Get Employee Contact By Contact ID, Get Job By Employee Identifier, Get Person By Employee Identifier, Get User Defined Fields By Employee Identifier

In the permissions table, select the checkbox for each scope listed.

<ul>
  <li>
    EmployeePersonDetails:View
  </li>

  <li>
    EmployeeContacts:View
  </li>

  <li>
    EmployeeUserDefinedFields:View
  </li>

  <li>
    EmployeeJobDetails:View
  </li>

  <li>
    EmployeeCompensationDetails:View
  </li>
</ul>

**3. Save the Service Account**

Click **Save**.

**4. Copy the password and User API Key**

UKG Pro generates a password and a User API Key (UserAccessKey) for the Service Account. It shows the password only once.

<ul>
  <li>Copy the generated password across.</li>
  <li>Copy the **User API Key** across. It appears in the grid next to the username.</li>
</ul>

**5. Copy the Customer API Key**

The Customer API Key (ClientAccessKey) is displayed at the top of the **Service Account Administration** page.

<ul>
  <li>Copy the **Customer API Key** across.</li>
</ul>

**6. Find the Web Services domain**

Open **Sidebar Menu** > **System Configuration** > **Security** > **Web Services**, then look at any Web Services endpoint URL displayed on the page.

<ul>
  <li>Format: `https://{subdomain}.{domain}/services/...`</li>
  <li>Example: `https://service2.ultipro.com/services/...`</li>
  <li>Copy the **Web Service Domain** across. It is the main domain, `ultipro.com` in the example.</li>
  <li>Copy the **Web Service Subdomain** across. It is the subdomain prefix, `service2` in the example.</li>
</ul>

## Reset an expired password

Service Account passwords may expire based on your organization's security policies.

<ul>
  <li>In Service Account Administration, select the Service Account.</li>
  <li>Click **Reset Password**.</li>
  <li>Copy the new password across.</li>
</ul>

## Link the Account

**1. Connect**

<ul>
  <li>Click **Connect**.</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup.</li>
</ul>

**2. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.