---
title: "UKG Pro - How do I link my account?"
slug: "ukg-pro-how-do-i-link-my-account"
tags: ["Customer Key", "Service User", "UKG Pro"]
updated: 2026-05-26T12:08:26Z
published: 2026-05-26T12:08:26Z
canonical: "docs.thrivelearning.com/ukg-pro-how-do-i-link-my-account"
---

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

# UKG Pro - How do I link my account?

This guide will walk you through retrieving your Customer API Key and creating a Service User in UKG Pro to complete your linking flow.

# Prerequisites

You must be an **Administrator** in your company's UKG Pro instance, or someone has shared their access with you.

# Instructions

### Step 1: Find your UKG Pro Customer API Key

1. Log in to UKG Pro and search "**Service Account Administration"** on the top right

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572660858-image.png?Expires=253370764800&Signature=nlFgJL6ve4YBrmS9RzgXrkfPufSaNb8D8fFvngtMogwnz-ndEXmyDUM86z842eQECRp2y1FX-fPOBVfUNgn2pBi6AIQnhRKGuPy8Jmm~IeDIoFEMna7JOJqZapV~0fDKTHa1JyfXuWu0g3n9rP3bUHa3XKqr-T8WqK8rZAOvnBEJjuoHosIsF-08m4XvHfuzEGVxckRNx-ZP049egaOGVMGP9Gpwp25i1h1fGdlWc77FXxwtdXLh~67MG7tKCq-PjDXJctj1qDUgMM6MLasokm1zVSzQSRtxFnq35fNmSX9FW4oinv8pKBPsXRKaJ-nk1MMMkBjtmHqmXkJIBtQRGg__&Key-Pair-Id=K3NV4LZ47N8M46)
2. Copy the Customer API Key from under the header

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572617320-image.png?Expires=253370764800&Signature=sDU74zBeXqCYx6oMoYrqGNRsyFhcQW8x8y0YOORBg5nlU8Ec0~551j17NK0O6pwvf6~xd5s9lrAu1MaXhMP3xnJ8VKmkojp9P~Re6f~9QhDqUWwat2FBWuDeV-dZx1jnEeTbj2J-01kGXWDJIHhzEHgIxYg6Bygo7m0qtsFmBD60isMT97qaiu-ywJi0P3K96rK4C2ywuIcOTalGHq1q0vGVi0YOjBBiv1gwqUkLQ73V4-0S8kyol4DX6~6bdw2hRMy2PHBqyyDynTGDMdZPen-fGxRRr-IRsIvftE11m20d3~Dpzv1n8oqZ6I8IpAr5YmG~qz7EBfO6eq7Y2OiD-w__&Key-Pair-Id=K3NV4LZ47N8M46)
3. Paste the Customer API Key in the linking flow.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572681595-image.png?Expires=253370764800&Signature=MKiv426A1wgEWM0xIUkacwkNKix6doICQZI5TOUooCABqtMjYOuKkkBe6D5Qs~LBMe6vx0B34-PL51DiIWb731XQ6pTR0Ia9ovMY36pWQPH4Q~S-FlTj4Fw8Wcw9QIJ9K1q12VhQQlhllB~TIxymGw6pNAY7o8grw-ZVaHIY2OU3hpHcWCF4DL~mBz7zy-TKRyh6~5S4m8uLTHzDTuiLcAWjC8KStHfsUYtlknj1FWM-l9178zxeTHzNkqb7wF3afScR4GQHUhVdG1ttpomLBuj9jhjp3j21GpqKphIJ1acUX5gMJWd-G277~J0bK~4~4qLH-hmNMOEN0L~GphOutg__&Key-Pair-Id=K3NV4LZ47N8M46)

## Step 2: Create Your Service Account

1. On the Service Account Administration Page, click "**+ add"** on the top right.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572751294-image.png?Expires=253370764800&Signature=AiGD~Sn4dFyCYLPR1hyW~cYCrRRIPNLdd02ymf~v~CsMvsU~afOwzi0WGdtQRdwtIrJC-S77Zl3R4b2qvYe03f9mnjTxqZCB~wjFV9l8UVp5Q42ZUakF6JBhbUN6L5FX54HLJf5tKIhh14kROCBxw6NUyf1MSBCl16HMM7sRP25Dan6CZ~nlqxIjbf2TbYsM5QeacQhRpy5mjyp9bFjs9JNB8wRBa-dR54wFR5eUS32lNJE2K3DgW7SnzcwNqvTQdYmLyZSn~6eO2nlTEgJYH3qr09BzoQLfeD5rQexfFD3W6grQ~Cbki1nioHTF4g8wEs-JXEQHuYK7rTmwdRqOVg__&Key-Pair-Id=K3NV4LZ47N8M46)
2. Create a new username and email for your service account. You will need the username later.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572779682-image.png?Expires=253370764800&Signature=WVWMTH0yLvvet-vC6UsE2jD3y6c-QqQHOZSQQlqJ45wPwqBwYjJDlLh1i-5FnXvZaZvcfF~1qJyZpndjMUPUaw67vnZudkhq6KNZmLE8t3sYTNQTL4LF0Z8wgwwZka2AVb3W3zrf2kb0qe5eR0n6pXopzdblO3EwIrwcSOzWrSh~HFs0MGDc6UpAEdfW6p9IJwFTtvH2FwtO7ewdhPOogCk8Q7UwhGH7VTn0zG5kBVVbhgyzityFpjn7tzqxonnpmh-5NLz2kZgO~JiWYoXMI1JHrwUuOosutnsVNEQTKYb6PCwpvHonRUov6MTfX6lpJKenMNO~CPfX1ed77FQxVA__&Key-Pair-Id=K3NV4LZ47N8M46)
3. On the same page, scroll down under Web Service to enable "**View Employee Person Details**". This is **REQUIRED.**

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572896206-image.png?Expires=253370764800&Signature=cmwVZWyO3p4ZQrL9Ffbjfn9UZ~CUfWjVAKBN0jaLONidyTbJ9T4zKbU~3dMwQ1rmXjqn7Ct1Gg6o5HVW7zuFvBZkzRP2-xvgER11DOeLuPSA4TE-D1SgYSFzxnq2kEXoAIAkseqzfz58o-wmrjPmP17US5-byaSAVAiCTSoUgdWOGrFi7kg0WkYHi3IpvjVwMlui86Q92MqQVDHpecoJbIFwvPUWzE-xpUygnNRlxSr8inuWkck21-4MLBVqY2JSnIE8fLp9W0Zpc0ZMgI8UJTBJjSK4T85lUCkO9BQ4ziN7ex2Fmu9lVNuUxX-nrzqG3r7pJSfkiK6jLpKxvc8Ckg__&Key-Pair-Id=K3NV4LZ47N8M46)
4. Depending on the use case, you may also be required to add some, or all, of these permissions:
  - Employee Pay Statement
  - Employee Employment Information
  - PTO Plan Integration
  - Company Configuration Integration
  - Payroll Integration
  - Personnel Integration
  - Employee Job History Details
  - Employee Compensation Details
  - Employee User Defined Fields

![](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2Fcb66df8a-4365-4d05-a28a-689060565dd9-CleanShot_2023-12-01_at_14.29.48.png?Expires=253370764800&Signature=QHMdh4hac-42kZ58wjF16xzLPzaiECDGMnzD9QC25x-bn9FGKcIsDDTXVGxrzfpeFFQ4aVTnOeQBSoYQFXHkbMqxgC7RVziECyRW1NyXFPuoIJT1J2FiKz5NZFWQEyfioeo1QHkIV6mVc8uCr3moiECn4knwgSMIcvzQUPU3eXvHXRuXBJSYXjiKPHk1PNkBwOq~piRa6vWXlCwzOi7gb3dxc~96OjvUpYPuveNsrVUsHkbL7XP78jYIYDRo2CUpmsWT0QtKll~JaCnqlPy6tzGZgaWbelgeym3o3qzQsr6a-U~tSJWTR8MDb6o8NBFPVdXY7njI9M97PXgxVmazTw__&Key-Pair-Id=K3NV4LZ47N8M46)![](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2Fdca0ee3d-a9f9-415c-bf23-6e1bb3a9174e-CleanShot_2023-12-01_at_14.29.56.png?Expires=253370764800&Signature=sxsZ-bNMrAxMxwT7mp6UDElgPPHb9~V6nfloGR5FUQyIboTp~GIt2P7Yb2E-QtkY~94ariJXP2fTCY21MSgC14ZMzq6G~ku7CbUQjDm77ygwcC4lQuWzVvXUXQ~ilu4BI0aWYDiNfXHyOmwVP1DeG1nYxf2~ngb4uo25LGcahmFYw3lPaPwOIosZ4llAuhYNXboXZs9iqLoMU3yzvgeVsjDID2F-AuaU6HzwYGCo9IggDMeFD3AvwIvTn4VikBmQEmYzVqgt2964pLxX8mOOQPIZ7POf14ayX-WR8dPJGlyQxQgqzbumDXWsIpqhJ53gU-zjkz5XkfJJVTb9ZzrXqg__&Key-Pair-Id=K3NV4LZ47N8M46)

1. Click **Save**. Your new password will pop up. Save the password in a secure location.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572929749-image.png?Expires=253370764800&Signature=rgs1QvosLlHuEAM1eG1oUtXwb46yh~eOX83EQcTcTwdjK5655WZMM7F0BECkU~1FcVwsAeaoNb3jN4gt0xwt0YX-jWEfDtGNM-vwZuxPl59NH0MU-5ckmICzW2DdlxqqqMcLC~a6PATq8dUAgnDbtxz85t04Dqebqu3EpX0dWOp5nraYWwZtZKdxSKetHX1zegR~gk4CJrJzdygwZTXba6cUeyO7AYVvEtLDH3mNuDxa5CebTecTHxdFzxD6p63cm-Veh62bEHxrxfwJ8SpcsK8ahuE7O7TO--zI3Q-~aIkIVHE~4OWf6AnlZhZ1wQXuCaDXPI8twlLjbwufv2ieXw__&Key-Pair-Id=K3NV4LZ47N8M46)

1. Enter your UKG Pro service account credentials in the linking flow and click **Submit**. This is user username of your service user and the password you just generated.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769572978174-image.png?Expires=253370764800&Signature=IaviTzEePxoiUhDqT34Uo8aT9UYC8txCImAMIjkL3Oj~rGDzCUGopw8JPfDRiEHTodLpyQBs-ANxYmNst8Srg0sOgtia8I6AjH12QW42~~Ws0UOCdV6GqMgstlA4hu3WCXkwHfplqq4TLTr61Dv6roQ~xYu8onNEqo7WVFzyGzsrEoeYWqsSsPEQm9Nvez-SkwiL5PtMeUXTZxo8usbSBdAwtcrjF7221KlSFnP9eLinGVtm0MQs7swRSHIpG1FQGdOlBY4-J2DKRKoJrDj~HBQKTLrbfiLsSAOFQG-MklAWL9lTDRlC2N9BZYG8Cj5SU4Ev1LCbCIMvAZBT9JhhXg__&Key-Pair-Id=K3NV4LZ47N8M46)

## Step 3: Finding your UKG Web Service Domain

1. In your search bar, search for **Web Services**.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769573023985-image.png?Expires=253370764800&Signature=Bgp3L7nH01ReXIN8wQYICKKVtYghOeCAjRToB08pmDHJKz17Zm~i4~HMyzxn8tNvABaI4G5dVjeU6~ohrRvZWgLlMqyOP9~6kFbNqFmKatUZG66KUjaq7sDlR--~TJ-pYSKaN385ZAAWKCFOECTh~uiXSEZN8IkfRZsI1vgJpEcdrNkUMIHqaClcBrKi9eQgcz5J-BxWMci2Xhx7CfTIEBw-eKzAXnBS2x-nEgYFCa24xWvwixZ-C8yWYW3076VAcih3MgPm7wB4TemSL2nagL2YTwLMGZOf-XeNdGnhjrrQKJTmCc54TvCSr-Ual3YZN39YSqZ3fDZAItAkeaRfUw__&Key-Pair-Id=K3NV4LZ47N8M46)
2. Look at any of the URLs on this page and copy one of them. For example your URL may look something like this: [http://Servicet.ultipro.com/services/BIDataService](http://Servicet.ultipro.com/services/BIDataService)

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769573271589-image.png?Expires=253370764800&Signature=jeTdvBX-D3y-LL73v-HqqHl1WbC4XvA8qeZ9aVeynGmrrE9mBcgyJansdgSVj-lQfBoQ4U2Yyq8H~JUzXrAllZ2toUCJr5eoPMUeSipPFMi4GAYMnx6nMuYcVEgq60sQzRDACHyhGUoqTwfUNWWLxx5U5OIOcfEbHcDcEbUfZtA0aMSmN8bsTa7Hs8Ai9ok5baKJiwfCqfEDw7RAw7ZQVzKXGIqIYBr9m40AFu7qi4wF-8P8yCgTevHj5b2ITMHKmM8wET4JOFBafKIaVhUHPWLBX9kfYGsEVsSleGnxIWbT3pQF1NVEqDOOHUhwsN9K8hyX72FatV~yT~IIO5plvQ__&Key-Pair-Id=K3NV4LZ47N8M46)
3. Enter the **URL** in the linking modal.

![image.png](https://assets.usepylon.com/f49877ed-d3d7-46e1-834d-1ddef64edf14%2F1769573288021-image.png?Expires=253370764800&Signature=V1C49EtUv6dsu3Qf~BEP2dyzg0mDv2nK2yxezt5c1XbJ6ZiqpfeFNoYRONGIS4NLa7h6c41Nd5Yc5IMCMkuUBOyf3y-EO2bkFRPVC2L47PJT0Z5R4cyw-y6tvhjCcpA09b7a2hyW9sQXo6YTw0j2vwZUtHLZlCBqOwAYV9TGvJtTH5ic6zEolDBLVDWBfaMTDLRevVn4FbEzLEDuKwE0lSSc2RNh7vNFU9qnzHJrF9e7YuFF0OY2csVeiAn3HlgEjfq~cN39Jwf5T-fSMtM3ZF43Brs6Hi93rBV1jlwECQSqKAMu6G0LpdYTM3EH4TtEXUDy02L12d5MFjnkn-ivYw__&Key-Pair-Id=K3NV4LZ47N8M46)

API (Application Programming Interface) is a set of protocols and tools that allow different software applications to communicate with each other. APIs enable the integration of third-party services, data exchange, and interaction between systems, allowing for enhanced functionality and streamlined workflows.