canonical: https://jentic.com/apis/people-doc.com/people-doc

# People Doc UKG HR Service Delivery API

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

## For AI agents

Manage people-doc.com resources and operations programmatically.

## Scope

Provides access to people-doc.com resources and operations as documented in the OpenAPI specification.

## Capabilities

- Access and manage people-doc.com resources
- Integrate people-doc.com functionality into workflows
- Automate people-doc.com operations

## Use cases

### people-doc.com Integration

Integrate UKG HR Service Delivery API into your application or workflow to automate operations and access resources programmatically.

Example prompt: Use the UKG HR Service Delivery API to perform operations against people-doc.com resources.

## Why Jentic

- **Setup:** Wiring UKG HR Service Delivery by hand means setting up its HTTP basic OAuth-application auth, choosing the right EU, US, or UltiPro host, and paging through employees and custom fields yourself. Through Jentic you install once, import the UKG HR Service Delivery API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** UKG HR Service Delivery puts the employee id in the URL path (`/employees/{id}`, `/employees/{id}/portal_invite`), so a rule can pin your agent to one employee record. You choose the operations it may call, so bulk employee changes or vault invites are included only if you add them.
- **Credential handling:** Your UKG HR Service Delivery credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up an employee record', and Jentic returns the matching UKG HR Service Delivery operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## FAQ

### What authentication does the UKG HR Service Delivery API use?

The UKG HR Service Delivery API uses none authentication. Through Jentic, credentials are stored encrypted and injected at execution time so they never enter the agent's context.

### How many endpoints does the UKG HR Service Delivery API have?

The UKG HR Service Delivery API exposes 231 endpoints across its surface area.

### Can I limit what my agent is allowed to do with the UKG HR Service Delivery API?

Yes. Jentic One is self-hosted by you, so your own rules decide which UKG HR Service Delivery operations and credentials the agent can use. Because the API puts the employee id in the URL path, such as `/employees/{id}` and `/employees/{id}/portal_invite`, a rule can pin the agent to a single employee record. You also choose the operations it may call, so bulk employee changes and portal invites are available only if you add them.