---
updatedAt: 2026-10-16T16:53:53.000Z
agentTools:
  projectIndex: https://developer.everee.com/llms.txt
---

# Update start/hire date

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "default",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.everee.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "basic",
        "description": "HTTP Basic. Send your API token (it begins with `tsk_prod_` for a Production instance or `tsk_test_` for a Sandbox instance) as the Base64-encoded user name, with no password: `Authorization: Basic base64(<token>:)`. Also send your company's tenant ID in the `x-everee-tenant-id` header. The partner onboarding endpoints take a partner API key (it begins with `zk_prod_`) in the same way."
      }
    },
    "schemas": {
      "WorkerMoney": {
        "type": "object",
        "description": "A monetary amount.",
        "properties": {
          "amount": {
            "type": "string",
            "description": "decimal number with format \"d+.dd\"",
            "example": "25.00"
          },
          "currency": {
            "type": "string",
            "description": "ISO4217 currency code",
            "example": "USD"
          }
        }
      },
      "Worker": {
        "type": "object",
        "title": "Worker",
        "description": "The Worker data structure. Fields that have not been recorded yet (for example while a worker is still onboarding) are returned as null or omitted. This is the same structure returned by every endpoint that responds with a worker.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The worker's identifier: your external worker ID if one has been set, otherwise Everee's generated worker ID. Use this value in the `{id}` path parameter of worker endpoints."
          },
          "firstName": {
            "type": "string"
          },
          "middleName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "phoneNumber": {
            "type": "string",
            "description": "10 digits"
          },
          "email": {
            "type": "string",
            "description": "email format"
          },
          "onboardingComplete": {
            "type": "boolean"
          },
          "hireDate": {
            "type": "string",
            "format": "date",
            "description": "ISO8601 date"
          },
          "terminationDate": {
            "type": "string",
            "format": "date",
            "description": "ISO8601 date. Only present once the worker has been separated."
          },
          "dateOfBirth": {
            "type": "string",
            "format": "date",
            "description": "ISO8601 date"
          },
          "taxpayerIdentifier": {
            "type": "string",
            "description": "9-digit numeric string (no hyphens or other characters)"
          },
          "tinVerificationStatus": {
            "type": "string",
            "description": "\"NEEDS_VERIFICATION\": TIN is pending verification\n\"SENT_FOR_VERIFICATION\": TIN has been submitted for verification\n\"VERIFIED\": TIN was verified successfully\n\"VERIFICATION_FAILED\": TIN failed verification and requires update\n\"UNABLE_TO_VERIFY\": TIN could not be submitted for verification",
            "enum": [
              "NEEDS_VERIFICATION",
              "SENT_FOR_VERIFICATION",
              "VERIFIED",
              "VERIFICATION_FAILED",
              "UNABLE_TO_VERIFY"
            ]
          },
          "typicalWeeklyHours": {
            "type": "integer",
            "format": "int32",
            "description": "integer in range 1-40 inclusive (employees only)"
          },
          "preferredPaymentMethod": {
            "type": "string",
            "description": "\"DIRECT_DEPOSIT\": worker is paid via ACH to a bank account\n\"PAY_CARD\": worker is paid on an Everee-managed pay card\n\"EXTERNALLY_PAID\": worker is paid outside Everee; Everee records the payments but moves no money. Set by enabling `externallyPaid` in `availablePaymentMethods` on [Update payment preferences](ref:update-payment-preferences).",
            "enum": [
              "DIRECT_DEPOSIT",
              "PAY_CARD",
              "EXTERNALLY_PAID"
            ]
          },
          "approvalGroup": {
            "type": "object",
            "description": "The worker's approval group, if assigned.",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            }
          },
          "documentGroups": {
            "type": "array",
            "description": "Names of the company document groups assigned to the worker.",
            "items": {
              "type": "string"
            }
          },
          "payrollCalendarId": {
            "type": "string",
            "example": "1042",
            "description": "The ID of the payroll calendar the worker is on, if any. See the [Payroll Calendar API](doc:payroll-calendar-api-guide)."
          },
          "position": {
            "type": "object",
            "description": "The worker's current position and compensation.",
            "properties": {
              "payType": {
                "type": "string",
                "description": "one of: \"HOURLY\", \"SALARY\"",
                "enum": [
                  "HOURLY",
                  "SALARY"
                ]
              },
              "payRate": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WorkerMoney"
                  }
                ],
                "description": "if payType = \"HOURLY\", then an hourly rate, or if payType = \"SALARY\", then an annual salary amount"
              },
              "title": {
                "type": "string"
              },
              "workersCompClassCode": {
                "type": "string",
                "description": "The worker's compensation class code, if assigned."
              },
              "costCenters": {
                "type": "array",
                "description": "The worker's default cost centers, each as a type key and value.",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "The cost center type key."
                    },
                    "value": {
                      "type": "string",
                      "description": "The cost center value within that type."
                    }
                  }
                }
              }
            }
          },
          "homeAddress": {
            "type": "object",
            "description": "The worker's current home address.",
            "properties": {
              "line1": {
                "type": "string"
              },
              "line2": {
                "type": "string"
              },
              "city": {
                "type": "string"
              },
              "state": {
                "type": "string",
                "description": "2-letter state abbreviation"
              },
              "postalCode": {
                "type": "string",
                "description": "5-digit ZIP code"
              }
            }
          },
          "bankAccounts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "bankName": {
                  "type": "string",
                  "description": "The bank's name, determined from `routingNumber` and formatted as the Federal Reserve publishes it, for example `BANK OF AMERICA, N.A.`. Read-only: it can't be set."
                },
                "accountName": {
                  "type": "string"
                },
                "accountType": {
                  "type": "string",
                  "description": "one of: \"CHECKING\", \"SAVINGS\"",
                  "enum": [
                    "CHECKING",
                    "SAVINGS"
                  ]
                },
                "routingNumber": {
                  "type": "string",
                  "description": "9 digits"
                },
                "accountNumberLast4": {
                  "type": "string",
                  "description": "last 4 digits of the account number"
                }
              }
            }
          },
          "withholdingSettings": {
            "type": "object",
            "description": "The worker's current federal W-4 withholding settings.",
            "properties": {
              "haveExactlyTwoJobs": {
                "type": "boolean"
              },
              "countOfChildren": {
                "type": "integer",
                "format": "int32"
              },
              "countOfOtherDependents": {
                "type": "integer",
                "format": "int32"
              },
              "otherIncomeAnnually": {
                "$ref": "#/components/schemas/WorkerMoney"
              },
              "deductionsAnnually": {
                "$ref": "#/components/schemas/WorkerMoney"
              },
              "extraWithholdingAmount": {
                "$ref": "#/components/schemas/WorkerMoney"
              },
              "exempt": {
                "type": "boolean"
              },
              "maritalStatus": {
                "type": "string",
                "enum": [
                  "HEAD_OF_HOUSEHOLD",
                  "MARRIED_FILING_JOINTLY",
                  "SINGLE_OR_MARRIED_FILING_SEPARATELY"
                ]
              }
            }
          },
          "legalWorkAddress": {
            "type": "object",
            "description": "The worker's current legal work location.",
            "properties": {
              "useHomeAddress": {
                "type": "boolean"
              },
              "name": {
                "type": "string",
                "description": "The name of the work location."
              },
              "workLocationId": {
                "type": "string",
                "description": "The company work location's ID. Omitted if `useHomeAddress` is true."
              },
              "address": {
                "type": "object",
                "properties": {
                  "line1": {
                    "type": "string"
                  },
                  "line2": {
                    "type": "string"
                  },
                  "city": {
                    "type": "string"
                  },
                  "state": {
                    "type": "string",
                    "description": "2-letter state abbreviation"
                  },
                  "postalCode": {
                    "type": "string",
                    "description": "5-digit ZIP code"
                  }
                }
              }
            }
          }
        },
        "example": {
          "id": "emp-1001",
          "firstName": "Johnny",
          "middleName": "B",
          "lastName": "Appleseed",
          "phoneNumber": "8002029399",
          "email": "johnny@appleseed.com",
          "onboardingComplete": true,
          "hireDate": "2024-01-15",
          "dateOfBirth": "1990-05-20",
          "taxpayerIdentifier": "123456789",
          "tinVerificationStatus": "VERIFIED",
          "typicalWeeklyHours": 40,
          "preferredPaymentMethod": "DIRECT_DEPOSIT",
          "approvalGroup": {
            "id": "123",
            "name": "Warehouse"
          },
          "position": {
            "payType": "HOURLY",
            "payRate": {
              "amount": "25.00",
              "currency": "USD"
            },
            "title": "Packer"
          },
          "homeAddress": {
            "line1": "123 Main St",
            "city": "Austin",
            "state": "TX",
            "postalCode": "78701"
          },
          "bankAccounts": [
            {
              "bankName": "BANK OF AMERICA, N.A.",
              "accountName": "Checking",
              "accountType": "CHECKING",
              "routingNumber": "111000025",
              "accountNumberLast4": "6789"
            }
          ],
          "legalWorkAddress": {
            "useHomeAddress": true,
            "name": "Home address",
            "address": {
              "line1": "123 Main St",
              "city": "Austin",
              "state": "TX",
              "postalCode": "78701"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/integration/v1/workers/{id}/hire-date": {
      "put": {
        "summary": "Update worker start or hire date",
        "description": "",
        "operationId": "update-worker-start-date",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "startDate"
                ],
                "properties": {
                  "startDate": {
                    "type": "string",
                    "format": "date"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Worker"
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": ""
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "The 'externalWorkerId' you assigned to the worker, or Everee's generated 'workerId' if you don't use your own IDs."
          }
        ]
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "x-everee-tenant-id",
        "value": "[numeric tenant or company ID]"
      },
      {
        "key": "accept",
        "value": "application/json"
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```