{
  "aid": "people-doc.com:main-2.0.0",
  "name": "UKG HR Service Delivery API",
  "type": "Index",
  "description": "\n\nDocumentation for client APIv2\n\n\n\n\n\n\n\n## Authorization Headers (People Fabric / Manager Persona)\n\n   Authorization for People Fabric (Pfab) APIs is based on the following headers:\n\n* `X-User-Integration-Key`: Represents the user identity in the system.\n* `X-Global-Tenant-Id`: Identifies the tenant (organization) in a multi-tenant environment.\n* `X-User-Type`: Specifies the type of user making the request, such as \"EMPLOYEE\" or \"SITEADMIN\".\n* `X-Employee-External-Id` (optional): Represents the tech id which is seen on employee profile in document manager\n\n\nThese 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.\n\n### Header Details:\n\n   - **X-User-Integration-Key**:\n       Also known as **UIK** (User Integration Key), this value is:\n         - Passed in the request header.\n         - Validated against the `saml_token#` persisted in the `NovaAuth` database.\n         - Synchronized during user account sync in Classic HRSD.\n         - Equivalent to: subject / user UUID / user integration key.\n\n   - **X-Global-Tenant-Id**:\n       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.\n\n  - **X-User-Type** :\n      This header indicates the type of user making the request. Possible values include:\n        - `EMPLOYEE`: Indicates a standard employee user.\n        - `SITEADMIN`: Indicates an administrative user with elevated privileges.\n\n\n    Only requests that include **above headers** will be authorized to access People Fabric APIs.\n\n### Example:\nGET /api/v2/client/pfab/employee_documents\n   Accept: application/json\n   Content-Type: application/json\n   Authorization: Bearer OAUTH_CLIENT_ACCESS_TOKEN\n   X-User-Integration-Key: USER_INTEGRATION_KEY\n   X-Global-Tenant-Id: GLOBAL_TENANT_ID\n   X-User-Type: USER_TYPE\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/people-doc.com/main/2.0.0/apis.json",
  "tags": [
    "people-doc.com",
    "main"
  ],
  "created": "2026-04-11",
  "modified": "2026-04-11",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "people-doc.com:main-2.0.0",
      "name": "UKG HR Service Delivery API",
      "description": "\n\nDocumentation for client APIv2\n\n\n\n\n\n\n\n## Authorization Headers (People Fabric / Manager Persona)\n\n   Authorization for People Fabric (Pfab) APIs is based on the following headers:\n\n* `X-User-Integration-Key`: Represents the user identity in the system.\n* `X-Global-Tenant-Id`: Identifies the tenant (organization) in a multi-tenant environment.\n* `X-User-Type`: Specifies the type of user making the request, such as \"EMPLOYEE\" or \"SITEADMIN\".\n* `X-Employee-External-Id` (optional): Represents the tech id which is seen on employee profile in document manager\n\n\nThese 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.\n\n### Header Details:\n\n   - **X-User-Integration-Key**:\n       Also known as **UIK** (User Integration Key), this value is:\n         - Passed in the request header.\n         - Validated against the `saml_token#` persisted in the `NovaAuth` database.\n         - Synchronized during user account sync in Classic HRSD.\n         - Equivalent to: subject / user UUID / user integration key.\n\n   - **X-Global-Tenant-Id**:\n       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.\n\n  - **X-User-Type** :\n      This header indicates the type of user making the request. Possible values include:\n        - `EMPLOYEE`: Indicates a standard employee user.\n        - `SITEADMIN`: Indicates an administrative user with elevated privileges.\n\n\n    Only requests that include **above headers** will be authorized to access People Fabric APIs.\n\n### Example:\nGET /api/v2/client/pfab/employee_documents\n   Accept: application/json\n   Content-Type: application/json\n   Authorization: Bearer OAUTH_CLIENT_ACCESS_TOKEN\n   X-User-Integration-Key: USER_INTEGRATION_KEY\n   X-Global-Tenant-Id: GLOBAL_TENANT_ID\n   X-User-Type: USER_TYPE\n",
      "image": "",
      "baseURL": "https://apis.eu.people-doc.com/api/v2",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/people-doc.com/main/2.0.0",
      "version": "2.0.0",
      "tags": [
        "people-doc.com",
        "main"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/people-doc.com/main/2.0.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/people-doc.com/main/2.0.0"
        }
      ]
    }
  ]
}