• State must be an ISO 3166-2 code. Example: US-CA. Read more about it here: https://en.wikipedia.org/wiki/ISO_3166-2
• Country must be an ISO 3166-1 Alpha-3 code. Example: USA. Read more about it here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3

• Hibob only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.

• workadress.id corresponds to the Work Site in Hibob. To get the list of Work Sites available in Hibob, refer to this example: https://developers.getknit.dev/docs/hibob#get-list-of-work-sites-from-hibob

• The fields not supported by this API for Hibob are:

  • employment -> workShiftId
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode

For more information and request examples, refer to https://developers.getknit.dev/docs/hibob#create-an-employee

Paycor supports two different employee creation flows, selected by metadata.workerCategory. If it is not supplied, or is anything other than Unpaid (case-insensitive), the Paid Employees flow below is used. If it is set to Unpaid, the Unpaid Employees flow is used instead, which calls a different Paycor endpoint with different supported fields and defaults.

Paid Employees (default)

Supported Request Fields:

• firstName - Required
• lastName - Required
• startDate - Falls back to metadata.HireDate, then to the current date, if not supplied
• workEmail
• personalEmails - Only the first email is used; any additional emails are ignored
• employment.designation - Sent as the Job Title. Must be an existing Job Title name in Paycor, can be obtained using a passthrough request with method GET and path /tenants/{tenantId}/jobtitles
• workAddress.id - Corresponds to the Work Location name in Paycor (not an ID). Must be an existing Work Location name, can be obtained using a passthrough request with method GET and path /legalentities/{legalEntityId}/worklocations, use the name value from this response
• employeeNumber
• birthDate
• gender - MALE/FEMALE are mapped to Paycor's Male/Female. Any other value is sent to Paycor as-is
• maritalStatus - MARRIED, SINGLE, WIDOWED, SEPARATED, DIVORCED are mapped to Paycor's equivalents. Any other value is sent to Paycor as-is
• phones.type, phones.phoneNumber - Only included if metadata.areaCode is also supplied (see below); otherwise phones is silently omitted from the request entirely. HOME, PERSONAL, and WORK are mapped to Paycor's Home, Mobile, and Work respectively

The fields not supported by this API for Paycor's Paid flow are:

• employment.positionId (Paycor has no ID-based Job Title lookup for this endpoint; use employment.designation instead)
• employment.workShiftId
• presentAddress (use metadata.addressLine1 / metadata.zipCode instead, see below)
• workAddress -> addressLine1, addressLine2, city, state, country, zipCode (only workAddress.id is used)

Additional Metadata:

• LegalEntityId - Required - can be obtained using a passthrough request with method GET and path /tenants/{tenantId}?include=All
• DepartmentCode - Required - can be obtained using a passthrough request with method GET and path /legalentities/{legalEntityId}/departments
• PaygroupDescription - Required - can be obtained using a passthrough request with method GET and path /legalentities/{legalEntityId}/payGroups , use the payGroupName value from this response.
• addressLine1 - Required if zipCode is not supplied (the employee's primary address street line)
• zipCode - Required if addressLine1 is not supplied (the employee's primary address zip code)
• areaCode - Required for phones to be included in the request; Paycor requires an area code alongside every phone number
• Status - Defaults to Active if not supplied
• HireDate - Used as a fallback for startDate if not supplied
• Any other key-value pairs can be passed in metadata and will be forwarded directly to the Paycor Create Employee API

Supported Response Fields:

• employeeId

Unpaid Employees (metadata.workerCategory = Unpaid)

This flow uses Paycor's Employee Onboarding API to add a pending-hire/unpaid worker, instead of immediately creating a full paid employee record.

Supported Request Fields:

• firstName - Required
• lastName - Required
• personalEmails - At least one of personalEmails or workEmail is required by Paycor. Only the first email is used, sent as the employee's home email
• workEmail - Used as a fallback home email if personalEmails is not supplied
• startDate - Falls back to metadata.HireDate, then to the current date, if not supplied
• employment.designation - Sent as the Job Title
• workAddress.id - Corresponds to the Work Location ID in Paycor for this flow (a GUID), unlike the Paid flow, which uses a name. Can be obtained using a passthrough request with method GET and path /legalentities/{legalEntityId}/worklocations, use the id value from this response
• presentAddress.addressLine1 - Falls back to metadata.addressLine1 if not supplied
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.zipCode - Falls back to metadata.zipCode if not supplied
• presentAddress.country
• phones.type, phones.phoneNumber - Only PERSONAL (sent as the mobile phone) and HOME (sent as the home phone) types are supported; WORK type phones are ignored. Unlike the Paid flow, no area code is required or sent
• gender - MALE/FEMALE are mapped to Paycor's Male/Female. Any other value is sent to Paycor as-is
• employmentType - FULL_TIME and PART_TIME are mapped to Paycor's full-time flag. Any other value leaves this unset, and it can be chosen later during onboarding in Paycor

Additional Metadata:

• LegalEntityId - Required
• DepartmentCode
• addressLine1 - Used as a fallback if presentAddress.addressLine1 is not supplied
• zipCode - Used as a fallback if presentAddress.zipCode is not supplied
• HireDate - Used as a fallback for startDate if not supplied
• Any other key-value pairs can be passed in metadata and will be forwarded directly to the Paycor Employee Onboarding API

Remarks

• This endpoint does not currently return an employeeId (it is always returned as null). The employee is added to Paycor's Onboarding queue.

• BambooHR only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored

• workadress.id corresponds to the Work Location in BambooHR. To get the list of Work Sites available in BambooHR, refer to this example: https://developers.getknit.dev/docs/getting-started-with-bamboohr-api#get-list-of-work-locations-from-bamboohr

• The fields not supported by this API for Hibob are:

  • employment -> workShiftId
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode

For more information and request examples, refer to https://developers.getknit.dev/docs/getting-started-with-bamboohr-api#update-an-employee-details-api-in-bamboohr

• workaddress.id corresponds to the Office Location in Personio

• The fields not supported by this API for Personio are:

  • employment -> workshiftId
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode
  • personalEmails

For more information and request examples, refer to https://developers.getknit.dev/docs/getting-started-with-personio-hris-api#create-an-employee-in-personio-api

• Darwinbox allows only one personal email per employee. If you pass more than one email in the personalEmails array, only the first will be taken, and the rest will be ignored

• workAddress.id corresponds to the Office Location Work Area Code in Darwinbox.

• You must include the following fields in the metadata field:

  • Selfservice*
  • Employee ID
  • FTE Value*

• workaddress.id corresponds to the Location in Keka

• The fields not supported by this API for Keka are:

  • personalEmails
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode

• You must include the following fields in the metadata field:

  • gender
  • dateOfBirth
  • dateJoined
  • employeeNumber (This is a user generated employee identifier eg, employee number, and is different from the internal identifier used by the app)
  • department
  • businessUnit

• Zoho People only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.

• The fields not supported by this API for Zoho People are:

  • employment -> workShiftId
  • workAddress

• You must include the following fields in the metadata field:

  • employeeId (This is a user generated employee identifier eg, employee number, and is different from the internal identifier used by the app)

Supported Request Fields:

• firstName - Required
• lastName - Required
• employment.positionId - Required
• employment.designation - Required
• workEmail - Required
• personalEmails

Additional Metadata:

• metadata.userId
• metadata.startDate
• metadata.payScaleArea - Required
• metadata.payScaleType - Required
• metadata.managerId
• metadata.gender
• metadata.nationality
• metadata.PerPerson.dateOfBirth
• metadata.EmpEmployment.originalStartDate
• metadata.EmpEmployment.firstDateWorked
• metadata.EmpJob
• metadata.PerPersonal.nativePreferredLang

Supported Response Fields:

• employeeId

To know more about which parameters are supported and request examples, please refer to: https://developers.getknit.dev/docs/create-employee-api-sap-successfactors

• Oracle Cloud HCM only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.

• You must include the following fields in the metadata field:

  • LegalEntityId

• The fields not supported by this API for Remote are:
  • personalEmails
  • employment->workshiftId
• You must include the following fields in the metadata field:
  • provisional_start_date
  • has_seniority_date

• Humaans only takes in 1 personal email for an employee. If you pass more than one email, only the first will be taken and rest will be ignored.

• The fields not supported by this API for Remote are:

  • employment->workshiftId
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode

• You must include the following fields in the metadata field:

  • employmentStartDate

• workaddress.id corresponds to the Site.

• The fields not supported by this API for Breathe are:

  • employment->workshiftId
  • personalEmails
  • workAddress -> addressLine1, addressLine2, city, state, country, zipCode

• You must include the following fields in the metadata field:

  • company_join_date

You must include the following fields in the metadata field:

• departmentId

workAddress in knit payload corresponds to personalAddress of a collaborator in PayFit

You must include the following fields in the metadata field:

• employeeNumber(Unique identifier in the company.)

Refer api specific guides - PrismHR API Guide

Supported Request Fields:

• firstName
• lastName
• employment.designation
• workEmail
• companyId - Required
• department - Required
• personalEmails
• employeeNumber
• startDate
• birthDate
• gender
• phones.type
• phones.phoneNumber
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• manager.id

Supported Response Fields:

• employeeId

Supported Request Fields:

• firstName
• lastName
• employeeNumber
• workEmail
• startDate
• birthDate
• phones
• phones.type
• phones.phoneNumber
• department - Required
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.country
• presentAddress.zipCode

Additional Metadata:

• internal_user_group - Required
• language_id - Required
• username - Required
• Any additional key-value pairs can be passed in metadata and will be forwarded to the TimeTac API

Supported Response Fields:

• employeeId

Please pass userPrincipalName, mailNickname and userPassword in metadata as they are mandatory for creating a employee in Entra

Supported Request Fields:

• firstName
• lastName
• workEmail
• gender - Allowed values - male female diverse not specified
• employmentType - Allowed values - apprentice externalWorker intern marginalEmployment regularEmployee shortTermEmployment studentTrainee
• startDate - YYYY-MM-DD format
• birthDate - YYYY-MM-DD format
• department - department Id obtained using list all departments API
• phones - only of one phone number of type WORK is honored.
• manager.id
• employment.designation
• presentAddress

Additional Metadata:

• metadata.personId - Required, The user id assigned to the person. Used as the login name. Unique identifier.

• metadata.personnelNumber - Required, The personnel number assigned to the person. Unique identifier.

• Any key-value pairs can be passed in metadata and will be forwarded to the HR Works API

Supported Request Fields:

• firstName
• lastName
• workEmail
• companyId - Required
• birthDate
• gender
• maritalStatus
• employeeNumber
• employment.positionId
• phones.type
• phones.phoneNumber
• personalEmails
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• manager.id

Additional Metadata:

• invitation - Required
• status - Required
• Any other custom field can be passed in metadata and will be included in the request body

Supported Response Fields:

• employeeId

Supported Request Fields:

• firstName - Required
• lastName - Required
• workEmail - Required

Additional Metadata:

• role - Required

Supported Response Fields:

• employeeId

Remarks
Include role in metadata. role can be "Regular User", "Project manager", "Team manager", "Executive manager", "Project viewer".

Supported Request Fields:

• firstName
• lastName
• workEmail
• employeeNumber
• phones
• startDate
• employmentType
• employment.designation

Additional Metadata:

• Any key-value pairs can be passed in metadata object

Supported Response Fields:

• employeeId

Remarks
Set employmentType to full_time, part_time or casual. employment.designation can be employee, department_admin, location-admin, company_admin.

Supported Request Fields:

• firstName - Required
• lastName - Required
• workEmail - Required
• department
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.zipCode
• employmentType
• gender
• phones.type
• phones.phoneNumber
• maritalStatus
• personalEmails

Remarks

• This endpoint does not return an employeeId. It adds the employee to onboarding. Once the hiring process is complete, the employee details can be retrieved via sync.

Supported Request Fields:

• firstName - Required
• lastName - Required
• workEmail
• birthDate - Required
• presentAddress.addressLine1 - Required
• presentAddress.addressLine2
• presentAddress.city - Required
• presentAddress.state - Required
• presentAddress.country - Required
• presentAddress.zipCode - Required
• employmentType - Not supported in AU and UK region
• gender - Required in UK region
• startDate - Not supported in NZ and UK region
• phones.type - Not supported in NZ and UK region
• phones.phoneNumber
• metadata

Supported Response Fields:

• employeeId

Supported Request Fields:

• firstName - Required
• lastName - Required
• workEmail - Required
• startDate
• birthDate
• gender
• phones.type - One phoneNumber with WORK type is supported
• phones.phoneNumber
• personalEmails - One personal email is supported
• employment.designation
• employmentType
• employeeNumber
• manager.id
• presentAddress.addressLine1
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• metadata

Supported Response Fields:

• employeeId

Remarks:

• gender should be passed as gender ID
• employment.designation should be passed as job ID
• employmentType should be passed as contract_type ID
• presentAddress.city should be passed as city option ID (integer)
• presentAddress.state should be passed as state option ID (integer)
• manager.id should reference an existing employee ID
• metadata can include additional fields like shouldInvite and permissionRoleId

Supported Request Fields:

• firstName
• lastName
• workEmail
• employment.designation
• employment.positionId
• employeeNumber
• startDate
• birthDate
• companyId
• department
• gender
• maritalStatus
• employmentType
• manager.id
• phones.phoneNumber
• phones.type
• workAddress.addressLine1
• workAddress.addressLine2
• workAddress.city
• workAddress.state
• workAddress.country
• workAddress.zipCode
• presentAddress.addressLine1
• presentAddress.addressLine2
• presentAddress.city
• presentAddress.state
• presentAddress.country
• presentAddress.zipCode
• permanentAddress.addressLine1
• permanentAddress.addressLine2
• permanentAddress.city
• permanentAddress.state
• permanentAddress.country
• permanentAddress.zipCode
• metadata

Supported Response Fields:

• employeeId

Supported Request Fields:

• firstName
• lastName
• startDate
• employeeNumber
• metadata

Supported Response Fields:

• employeeId

Supported Request Fields:

• firstName
• lastName
• workEmail
• employeeNumber
• startDate
• birthDate
• gender
• employeeNumber
• metadata

Supported Response Fields:

• employeeId