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

# Create employee with form

> Create an employee, based on the form schema.

<Accordion title="Supported integrations" icon="list-check">
  This feature is currently available for the following integrations:

  <ul>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/personio">Personio</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/workday">Workday</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/ukgprowfm/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/ukgready">UKG Ready</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/bamboohr">BambooHR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/kenjo/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/kenjo">Kenjo</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/hibob/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/hibob">HiBob</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/entraid/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/azuread/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/remotecom/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/remotecom">Remote</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/humaans/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/humaans">Humaans</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/oraclehcm/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/hrworks/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/hrworks">HR WORKS</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/zohopeople/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/zohopeople">Zoho People</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/gusto/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/gusto">Gusto</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/alexishr/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/alexishr">AlexisHR</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/simployer/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/simployer">Simployer</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/dayforce/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/dayforce">Dayforce</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/lattice/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/lattice">Lattice</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/trinetpeo/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paylocity">Paylocity</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paycor">Paycor</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paycom/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paycom">Paycom</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/insperity/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/insperity">Insperity</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/paychex/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/paychex">Paychex</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/planday/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/planday">Planday</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/leapsome/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/leapsome">Leapsome</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sdworx/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sdworx">SD Worx</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/absenceio/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/absenceio">Absence.io</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/a3innuvanomina/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sympa/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sympa">Sympa</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/youforce/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>
    <li class="flex items-center"><img src="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg" height="16px" width="16px" class="m-0 mr-2" /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>
  </ul>

  You'd like to see this feature for another integration? Please reach out!
  We're always happy to discuss extending our coverage.
</Accordion>

<Note>
  This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes).
</Note>

### Example Request Body

```json theme={null}
{
  "staffing_entity_id": "26vafvWSRmbhNcxJYqjCzuJg",
  "properties": {
    "firstName": "John",
    "startDate": "2025-01-01",
    "workLocation": {
      "site": "8e422bf8cav",
      "keyNumbers": [
        142,
        525,
        63
      ]
    }
  }
}
```


## OpenAPI

````yaml POST /hris/employees/form
openapi: 3.1.0
info:
  title: Kombo API
  version: 1.0.0
servers:
  - url: https://api.kombo.dev/v1
    description: Kombo EU API
  - url: https://api.us.kombo.dev/v1
    description: Kombo US API
security:
  - ApiKey: []
tags:
  - name: General
  - name: Kombo Connect
    description: >-
      Endpoints for Kombo Connect, our end-user-facing flow for setting up new
      integrations.
  - name: Unified HRIS API
    description: Unified endpoints to access all the HR concepts you might need.
  - name: Unified ATS API
    description: Unified endpoints to access all the ATS concepts you might need.
  - name: Unified ATS (Assessment & Background Check) API
    description: >-
      Unified endpoints to operate Assessments and Background Checks for many
      applicant tracking systems.
  - name: Unified LMS API
    description: Unified endpoints to access all the LMS concepts you might need.
  - name: AI Apply
    description: Endpoints for AI-powered job application features.
  - name: Custom Endpoints
    description: Custom integration-specific endpoints.
paths:
  /hris/employees/form:
    post:
      tags:
        - Unified HRIS API
      summary: Create employee with form
      description: >-
        Create an employee, based on the form schema.


        <Accordion title="Supported integrations" icon="list-check">

        This feature is currently available for the following integrations:


        <ul>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/personio/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/personio">Personio</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/workday/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/workday">Workday</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/successfactors/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/successfactors">SAP SuccessFactors</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/ukgpro/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/ukgpro">UKG Pro</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/ukgprowfm/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/ukgprowfm">UKG Pro WFM</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/ukgready/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/ukgready">UKG Ready</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/adpworkforcenow/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/adpworkforcenow">ADP Workforce Now</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/bamboohr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/bamboohr">BambooHR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/kenjo/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/kenjo">Kenjo</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/hibob/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/hibob">HiBob</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/entraid/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/entraid">Microsoft Entra ID</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/azuread/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/azuread">Microsoft Azure AD</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/remotecom/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/remotecom">Remote</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/humaans/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/humaans">Humaans</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/oraclehcm/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/oraclehcm">Oracle HCM</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/hrworks/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/hrworks">HR WORKS</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/zohopeople/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/zohopeople">Zoho People</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/gusto/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/gusto">Gusto</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/alexishr/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/alexishr">AlexisHR</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/simployer/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/simployer">Simployer</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/dayforce/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/dayforce">Dayforce</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/lattice/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/lattice">Lattice</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/trinetpeo/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/trinetpeo">TriNet PEO</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/paylocity/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/paylocity">Paylocity</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/paycor/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/paycor">Paycor</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/paycom/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/paycom">Paycom</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/insperity/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/insperity">Insperity</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/paychex/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/paychex">Paychex</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/planday/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/planday">Planday</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/leapsome/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/leapsome">Leapsome</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sdworx/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sdworx">SD Worx</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/absenceio/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/absenceio">Absence.io</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/a3innuvanomina/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/a3innuvanomina">a3innuva Nómina</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sympa/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sympa">Sympa</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/youforce/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/youforce">Visma Raet - Youforce</a></li>

        <li class="flex items-center"><img
          src="https://storage.googleapis.com/kombo-assets/integrations/sandbox/icon.svg"
          height="16px"
          width="16px"
          class="m-0 mr-2"
        /><a href="/hris/connectors/sandbox">Kombo Sandbox</a></li>

        </ul>


        You'd like to see this feature for another integration? Please reach
        out!

        We're always happy to discuss extending our coverage.

        </Accordion>



        <Note>
          This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes).
        </Note>


        ### Example Request Body


        ```json

        {
          "staffing_entity_id": "26vafvWSRmbhNcxJYqjCzuJg",
          "properties": {
            "firstName": "John",
            "startDate": "2025-01-01",
            "workLocation": {
              "site": "8e422bf8cav",
              "keyNumbers": [
                142,
                525,
                63
              ]
            }
          }
        }

        ```
      operationId: PostHrisEmployeesForm
      parameters:
        - in: header
          name: X-Integration-Id
          schema:
            type: string
          description: ID of the integration you want to interact with.
          example: bamboohr:HWUTwvyx2wLoSUHphiWVrp28
          required: true
      requestBody:
        description: POST /hris/employees/form Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostHrisEmployeesFormRequestBody'
            examples:
              example1:
                value:
                  staffing_entity_id: 26vafvWSRmbhNcxJYqjCzuJg
                  properties:
                    firstName: John
                    startDate: '2025-01-01'
                    workLocation:
                      site: 8e422bf8cav
                      keyNumbers:
                        - 142
                        - 525
                        - 63
      responses:
        '200':
          description: POST /hris/employees/form Positive response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostHrisEmployeesFormPositiveResponse'
              examples:
                example1:
                  value:
                    status: success
                    data:
                      id: 26vafvWSRmbhNcxJYqjCzuJg
                      remote_id: '12345'
                      prehire:
                        remote_id: null
                    warnings:
                      - message: This is an example warning!
        default:
          $ref: '#/components/responses/ErrorResponseHRIS'
      x-codeSamples:
        - lang: python
          label: PostHrisEmployeesForm
          source: |-
            from kombo import Kombo


            with Kombo(
                integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
                api_key="<YOUR_BEARER_TOKEN_HERE>",
            ) as k_client:

                res = k_client.hris.create_employee_with_form(properties={
                    "firstName": "John",
                    "startDate": "2025-01-01T00:00:00Z",
                    "workLocation": {
                        "site": "8e422bf8cav",
                        "keyNumbers": {
                            "0": 142,
                            "1": 525,
                            "2": 63,
                        },
                    },
                }, staffing_entity_id="26vafvWSRmbhNcxJYqjCzuJg")

                # Handle response
                print(res)
        - lang: typescript
          label: PostHrisEmployeesForm
          source: |-
            import { Kombo } from "@kombo-api/sdk";

            const kombo = new Kombo({
              integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
              api_key: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await kombo.hris.createEmployeeWithForm({
                staffing_entity_id: "26vafvWSRmbhNcxJYqjCzuJg",
                properties: {
                  "firstName": "John",
                  "startDate": "2025-01-01T00:00:00Z",
                  "workLocation": {
                    "site": "8e422bf8cav",
                    "keyNumbers": {
                      "0": 142,
                      "1": 525,
                      "2": 63,
                    },
                  },
                },
              });

              console.log(result);
            }

            run();
        - lang: ruby
          label: PostHrisEmployeesForm
          source: >-
            require 'kombo'


            Models = ::Kombo::Models

            s = ::Kombo::Kombo.new(
              integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
              security: Models::Shared::Security.new(
                api_key: '<YOUR_BEARER_TOKEN_HERE>'
              )
            )

            res = s.hris.create_employee_with_form(body:
            Models::Shared::PostHrisEmployeesFormRequestBody.new(
              staffing_entity_id: '26vafvWSRmbhNcxJYqjCzuJg',
              properties: {
                'firstName' => 'John',
                'startDate' => '2025-01-01T00:00:00Z',
                'workLocation' => {
                  'keyNumbers' => {
                    '0' => 142.0,
                    '1' => 525.0,
                    '2' => 63.0,
                  },
                  'site' => '8e422bf8cav',
                },
              }
            ))


            unless res.post_hris_employees_form_positive_response.nil?
              # handle response
            end
components:
  schemas:
    PostHrisEmployeesFormRequestBody:
      type: object
      properties:
        staffing_entity_id:
          type: string
          minLength: 24
          maxLength: 24
          pattern: ^[1-9A-HJ-NP-Za-km-z]+$
        properties:
          $ref: '#/components/schemas/Schema3'
      required:
        - properties
    PostHrisEmployeesFormPositiveResponse:
      type: object
      properties:
        status:
          type: string
          const: success
        data:
          type: object
          properties:
            id:
              type:
                - string
                - 'null'
              description: >-
                The Kombo id of the created employee. If null, we only created a
                pre-hire which shows up in the next sync after a successful
                onboarding.
            remote_id:
              type:
                - string
                - 'null'
              description: >-
                The raw ID of the created employee in the remote system. This is
                only populated when `id` is set (i.e., when a full employee was
                created). For pre-hires, use the `prehire` object instead.
            prehire:
              type: object
              properties:
                remote_id:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The temporary ID returned by the remote system when creating
                    a pre-hire.
              required:
                - remote_id
              description: >-
                An object containing the temporary pre-hire information from the
                remote system. This ID may change or become invalid when the
                pre-hire becomes a full employee. Only populated when `id` is
                null.
          required:
            - id
            - remote_id
            - prehire
          examples:
            - id: 26vafvWSRmbhNcxJYqjCzuJg
              remote_id: '12345'
              prehire:
                remote_id: null
        warnings:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: >-
            These are the interaction warnings that are shown in the dashboard.
            They are meant to provide debug information to you. We recommend
            logging them to the console.
      required:
        - status
        - data
        - warnings
    Schema3:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Schema4'
    Schema4:
      oneOf:
        - type: string
        - type: number
          format: double
          minimum: -1.7976931348623157e+308
        - type: boolean
        - $ref: '#/components/schemas/Schema5'
        - $ref: '#/components/schemas/Schema6'
    Schema5:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/Schema4'
    Schema6:
      type: array
      items:
        $ref: '#/components/schemas/Schema4'
  responses:
    ErrorResponseHRIS:
      description: The standard error response with the error codes for the HRIS use case.
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                enum:
                  - error
              error:
                type: object
                properties:
                  code:
                    type:
                      - string
                      - 'null'
                    enum:
                      - PLATFORM.RATE_LIMIT_EXCEEDED
                      - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED
                      - PLATFORM.INTEGRATION_NOT_FOUND
                      - PLATFORM.INPUT_INVALID
                      - PLATFORM.UNKNOWN_ERROR
                      - PLATFORM.IP_NOT_WHITELISTED
                      - PLATFORM.AUTHENTICATION_INVALID
                      - PLATFORM.TASK_TIMED_OUT
                      - INTEGRATION.PERMISSION_MISSING
                      - INTEGRATION.AUTHENTICATION_INVALID
                      - INTEGRATION.QA_FAILED
                      - INTEGRATION.SETUP_SYNC_PENDING
                      - INTEGRATION.SETUP_INCOMPLETE
                      - INTEGRATION.INACTIVE
                      - INTEGRATION.MODEL_NOT_AVAILABLE
                      - INTEGRATION.MODEL_DISABLED
                      - INTEGRATION.ACTION_NOT_AVAILABLE
                      - INTEGRATION.ACTION_DISABLED
                      - REMOTE.SERVICE_UNAVAILABLE
                      - REMOTE.RATE_LIMIT_EXCEEDED
                      - REMOTE.INPUT_INVALID
                      - REMOTE.UNKNOWN_HTTP_ERROR
                      - HRIS.STAFFING_ENTITY_CLOSED
                      - HRIS.EMPLOYEE_ALREADY_EXISTS
                    example: HRIS.EMPLOYEE_ALREADY_EXISTS
                    description: >-
                      Some errors include an error code that can be used to
                      identify their cause. See the [Error Handling
                      Docs](https://docs.kombo.dev/guides/errors) for more
                      information. For your error handling logic please use the
                      error `code` instead of other properties (e.g. message,
                      http status code, ...).
                  title:
                    type:
                      - string
                      - 'null'
                    description: A static, human-readable label.
                  message:
                    type: string
                    description: >-
                      A dynamic, detailed description of what went wrong in this
                      specific instance.
                  log_url:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: >-
                      The log page in the Kombo UI lists every interaction with
                      full details. If you need assistance, share that link with
                      our support team.
                required:
                  - code
                  - title
                  - message
                  - log_url
                description: Error details with structured code for programmatic handling.
            required:
              - status
              - error
          examples:
            Error Response:
              description: >-
                When building error handling logic, always use the `code` field
                to identify specific error types programmatically. See the
                complete list of error codes in the
                [docs](https://docs.kombo.dev/guides/errors).
              value:
                status: error
                error:
                  code: INTEGRATION.MODEL_NOT_AVAILABLE
                  title: >-
                    This data model isn't supported for the selected
                    integration.
                  message: >-
                    The "employees" model is not yet available for Greenhouse.
                    Please reach out to Kombo if you need this functionality.
                  log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456
            Minimal Error Response:
              description: >-
                The "message" is always required while other fields can also be
                `null`. See the [docs](https://docs.kombo.dev/guides/errors) for
                more information.
              value:
                status: error
                error:
                  code: null
                  title: null
                  message: The message is always in the response.
                  log_url: null
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        Create an API key on the [Secrets](https://app.kombo.dev/secrets) page
        in the Kombo dashboard.

````