People Doc UKG HR Service Delivery API
✓ Official Vendor SpecBusiness OperationsHr Managementnone231 EndpointsREST
For Agents
Manage people-doc.com resources and operations programmatically.
Use for: I need to integrate with people-doc.com, How do I access people-doc.com data programmatically, Help me automate people-doc.com tasks
Not supported: Provides access to people-doc.com resources and operations as documented in the OpenAPI specification.
Documentation for client APIv2 ## Authorization Headers (People Fabric / Manager Persona) Authorization for People Fabric (Pfab) APIs is based on the following headers: * `X-User-Integration-Key`: Represents the user identity in the system. * `X-Global-Tenant-Id`: Identifies the tenant (organization) in a multi-tenant environment. * `X-User-Type`: Specifies the type of user making the request, such as "EMPLOYEE" or "SITEADMIN". * `X-Employee-External-Id` (optional): Represents the tech id which is seen on employee profile in document manager These headers are **required**, as they are tied to complex business logic embedded in the called application and help establish context for both the API request and its response. ### Header Details: - **X-User-Integration-Key**: Also known as **UIK** (User Integration Key), this value is: - Passed in the request header. - Validated against the `saml_token#` persisted in the `NovaAuth` database. - Synchronized during user account sync in Classic HRSD. - Equivalent to: subject / user UUID / user integration key. - **X-Global-Tenant-Id**: A **Global Tenant ID** is a UUID uniquely identifying a tenant in a multi-tenant setup. It determines the organizational scope of the API request. - **X-User-Type** : This header indicates the type of user making the request. Possible values include: - `EMPLOYEE`: Indicates a standard employee user. - `SITEADMIN`: Indicates an administrative user with elevated privileges. Only requests that include **above headers** will be authorized to access People Fabric APIs. ### Example: GET /api/v2/client/pfab/employee_documents Accept: application/json Content-Type: application/json Authorization: Bearer OAUTH_CLIENT_ACCESS_TOKEN X-User-Integration-Key: USER_INTEGRATION_KEY X-Global-Tenant-Id: GLOBAL_TENANT_ID X-User-Type: USER_TYPE
Install Jentic One Beta
Connect the UKG HR Service Delivery API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the UKG HR Service Delivery API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with UKG HR Service Delivery API.
Access and manage people-doc.com resources
Integrate people-doc.com functionality into workflows
Automate people-doc.com operations
Use Cases
GET STARTED
