Creates a new employee for the specified company.

post

https://api.worklio.com/wep/companies/{companyId}/employees

Access: System, Admin, and ClientAdmin users only.

When payroll address validation suggests a corrected address, the endpoint responds with HTTP 400 and an AddressFix_v10 payload instead of creating the employee.

For non-US residential addresses, the request is accepted only when Global HR is enabled for the company.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

int32

required

Identifier of the company where the employee should be created.

Body Params

Employee creation payload.

Request payload used to create a new employee.

firstName

string | null

required

First name.

lastName

string | null

required

Last name.

middleName

string | null

Middle name.

nickName

string | null

Nickname.

employeeType

int32

enum

Type of the employee.

Members:

0 - Employee ( Employee )
1 - Contractor ( Contractor )

Allowed:

ssn

string | null

Employee SSN or contractor FEIN. Required for US workers and immutable after creation.

globalID

string | null

Global identification value for non-US workers. Required when the employee country is not US and immutable after creation.

birthDate

date-time | null

required

Employee date of birth in yyyy-MM-dd format. Required. Data type is validated and must be Number

hireDate

date-time | null

Hire date. Data type is validated and must be Number

string | null

Personal email.

workEmail

string | null

Work email.

phone

string | null

Personal phone.

cellPhone

string | null

Cell phone.

workPhone

string | null

Work phone.

workCellPhone

string | null

Work Cell phone.

residentialAddress

object

Request payload used to create a postal address.

contract

object

Payload used to create a new employee contract.

payAllocation

array of objects | null

Net pay detail.

payAllocation

object

New login access level and password.

metaData

string | null

Custom metadata string stored with the employee record.

country

string | null

ISO country code that drives country-specific validation and identification rules.

citizenship

int32

enum

Members:

1 - USCitizen ( USCitizen. )
2 - PernamentResident ( PernamentResident. )
3 - ResidentAlien ( ResidentAlien. )
4 - NonResidentAlien ( NonResidentAlien. )

Allowed:

citizenshipCountry

string | null

CitizenshipCountry.

bio

string | null

Bio.

gender

int32

enum

Members:

1 - Female ( Female. )
2 - Male ( Male. )
3 - Other ( Other. )

Allowed:

genderIdentity

int32 | null

Gender Identity Id

pronouns

int32

enum

Members:

1 - HeHimHis ( HeHimHis. )
2 - TheThemTheirs ( TheThemTheirs. )
3 - ZeHirHirs ( ZeHirHirs. )
4 - ZeZirZirs ( ZeZirZirs. )
5 - SheHerHers ( SheHerHers. )
6 - Other ( Other. )
7 - PreferNotToAnswer ( PreferNotToAnswer. )

Allowed:

eeo

object

Equal Employment Opportunity demographic information stored for an employee.

driverLicence

object

Employee's Driver's License.

maritalStatus

int32

enum

Members:

1 - Single ( Single. )
2 - Married ( Married. )
3 - Separated ( Separated. )
4 - DivorcedOrWidowed ( Divorced or Widowed. )

Allowed:

employeeUI_ID

int32 | null

≥ 0

Employee UI ID (aka Employee Number).

jobDescription

string | null

Job Description.

Headers

api-version

string

Defaults to 1.0

The requested API version

x-api-version

string

Defaults to 1.0

The requested API version

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200OK

400Bad Request