API ReferenceEmployees

Create an employee

Creates an employee with the linked employer. If the employer has an active health insurance scheme that automatically provides insurance to employees the employee will be enrolled.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringOptional

Unique key to ensure idempotent requests. If the same key is used for multiple identical & successful requests, the same response will be returned. Read more here

Request

This endpoint expects an object.
employer_idstringRequiredformat: "er_.+"
first_namestringRequired
It can include the middle name. Must not be empty
last_namestringRequired
Must not be empty
date_of_birthstringRequiredformat: "date"

Must be in the past, but after 1900-01-01

sex_at_birthenumRequired
Allowed values:
home_addressobjectRequired
Location where the employee is legally registered to live
national_tax_idstringRequired

PPSN in Ireland, NINo in the UK, DNI/NIE in Spain. Must not be empty

start_onstringRequiredformat: "date"

Employment start date. Must be after 1900-01-01, can be in the future

phone_numberstringRequired

Phone number in E.164 international format (e.g. +447700900999)

emailstringRequired
Must not be empty
external_customer_idstringOptional

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only required for EoR platforms.

nationalityenumOptional
bank_accountobjectOptional
Bank account details

Response

OK
first_namestring
last_namestring
date_of_birthstringformat: "date"
sex_at_birthenum
Allowed values:
national_tax_idstring
phone_numberstring
emailstring
platform_idstringOptionalformat: "pt_.+"
idstringOptionalformat: "ee_.+"
employer_idstringOptionalformat: "er_.+"
statusenumOptional
Allowed values:
external_customer_idstringOptional

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.

home_addressobjectOptional
nationalityenumOptional
start_onstringOptionalformat: "date"
offboard_onstringOptionalformat: "date-time"
bank_accountobjectOptional
objectstringOptional
The object type

Errors