Create Employee

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Body

application/json

title

string | null

The prefix of the employee's name (e.g., Mr, Ms, Dr)

Example:

"Mr"

first_name

string | null

The employee first name

Example:

"Isaac"

last_name

string | null

The employee last name

Example:

"Newton"

name

string | null

The employee name

Example:

"Isaac Newton"

display_name

string | null

The employee display name

Example:

"Sir Isaac Newton"

avatar_url

string | null

The employee avatar Url

Example:

"https://example.com/avatar.png"

personal_email

string | null

The employee personal email

Example:

"[email protected]"

personal_phone_number

string | null

The employee personal phone number

Example:

"+1234567890"

work_email

string | null

The employee work email

Example:

"[email protected]"

work_phone_number

string | null

The employee work phone number

Example:

"+1234567890"

job_id

string | null

deprecated

The employee job id

Example:

"R-6789"

job_title

string | null

If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written

Example:

"Physicist"

department_id

string | null

The employee department id

Example:

"3093"

team_id

string | null

The employee team id

Example:

"2913"

department

string | null

The employee department

Example:

"Physics"

manager_id

string | null

The employee manager ID

Example:

"67890"

gender

object

The employee gender

Show child attributes

gender.value

enum<string> | null

Available options:

male,

female,

non_binary,

other,

not_disclosed,

diverse,

unmapped_value,

gender.source_value

Example:

"male"

preferred_language

object

The employee preferred language

Show child attributes

preferred_language.value

enum<string> | null

The ISO639-2 Code of the language

Available options:

aar,

afr,

amh,

ara,

aym,

aze,

bel,

bul,

bis,

ben,

bos,

byn,

cat,

cha,

ces,

dan,

deu,

div,

dzo,

ell,

eng,

spa,

est,

fas,

fan,

ful,

fin,

fij,

fao,

fra,

gle,

grn,

guj,

glv,

heb,

hin,

hrv,

hat,

hun,

hye,

ind,

isl,

ita,

jpn,

kat,

kon,

kaz,

kal,

khm,

kor,

kur,

kir,

lat,

ltz,

lin,

lao,

lit,

lub,

lav,

mlg,

mah,

mri,

mkd,

mon,

mar,

msa,

mlt,

mya,

nob,

nep,

nld,

nno,

nor,

nbl,

nya,

pan,

pol,

pus,

por,

que,

rar,

roh,

rup,

ron,

rus,

kin,

sme,

sag,

sin,

slk,

slv,

smo,

sna,

som,

sqi,

srp,

ssw,

swe,

swa,

tam,

tel,

tgk,

tha,

tir,

tig,

tuk,

tsn,

ton,

tur,

tso,

ukr,

urd,

uzb,

ven,

vie,

xho,

zho,

zul,

unmapped_value,

Example:

"eng"

preferred_language.source_value

Example:

"eng"

ethnicity

object

The employee ethnicity

Show child attributes

ethnicity.value

enum<string> | null

Available options:

white,

black_or_african_american,

asian,

hispanic_or_latino,

american_indian_or_alaska_native,

native_hawaiian_or_pacific_islander,

two_or_more_races,

not_disclosed,

other,

unmapped_value,

ethnicity.source_value

Example:

"white"

date_of_birth

string<date-time> | null

The date when the employee was born

Example:

"1990-01-01T00:00:00.000Z"

birthday

string<date-time> | null

The next birthday of the employee (upcoming birthday)

Example:

"2021-01-01T00:00:00Z"

marital_status

object

The employee marital status

Show child attributes

marital_status.value

enum<string> | null

Available options:

single,

married,

common_law,

divorced,

widowed,

domestic_partnership,

separated,

other,

not_disclosed,

unmapped_value,

marital_status.source_value

Example:

"single"

avatar

object

The employee avatar

Show child attributes

avatar.url

string | null

avatar.base64

string | null

Example:

"https://example.com/avatar.png"

hire_date

string<date-time> | null

The employee hire date

Example:

"2021-01-01T00:00:00.000Z"

start_date

string<date-time> | null

The employee start date

Example:

"2021-01-01T00:00:00.000Z"

employment_type

object

deprecated

The employee employment type

Show child attributes

employment_type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

employment_type.source_value

Example:

"permanent"

employment_contract_type

object

deprecated

The employment work schedule type (e.g., full-time, part-time)

Show child attributes

employment_contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

employment_contract_type.source_value

Example:

"full_time"

employment_status

object

The employee employment status

Show child attributes

employment_status.value

enum<string> | null

Available options:

active,

pending,

terminated,

leave,

inactive,

unknown,

unmapped_value,

employment_status.source_value

Example:

"active"

termination_date

string<date-time> | null

The employee termination date

Example:

"2021-01-01T00:00:00Z"

company_name

string | null

deprecated

The employee company name

Example:

"Example Corp"

company_id

string | null

The employee company id

Example:

"1234567890"

citizenships

object[] | null

The citizenships of the Employee

Show child attributes

citizenships.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value,

Example:

"US"

citizenships.source_value

employments

object[] | null

deprecated

The employee employments

Show child attributes

employments.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

employments.job_title

string | null

The job title of the employee

Example:

"Software Engineer"

employments.pay_rate

string | null

The amount of compensation for the employee

Example:

"40.00"

employments.pay_period

object

The time period over which the pay rate is calculated

Show child attributes

employments.pay_period.value

enum<string> | null

Available options:

hour,

day,

week,

every_two_weeks,

month,

quarter,

every_six_months,

year,

unmapped_value,

employments.pay_period.source_value

Example:

"monthly"

employments.pay_frequency

object

How often the employee is paid

Show child attributes

employments.pay_frequency.value

enum<string> | null

Available options:

hourly,

weekly,

bi_weekly,

four_weekly,

semi_monthly,

monthly,

bi_monthly,

quarterly,

semi_annually,

yearly,

thirteen_monthly,

pro_rata,

unmapped_value,

half_yearly,

daily,

fixed,

employments.pay_frequency.source_value

Example:

"hourly"

employments.pay_currency

string | null

The currency used for pay

Example:

"USD"

employments.effective_date

string<date-time> | null

The effective date of the employment contract

Example:

"2021-01-01T01:01:01.000Z"

employments.end_date

string<date-time> | null

The end date of employment

Example:

"2021-01-01T01:01:01.000Z"

employments.grade

object

Represents the employee’s position within the organizational hierarchy.

Show child attributes

employments.grade.id

string | null

The reference id

Example:

"1687-3"

employments.grade.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employments.grade.name

string | null

The reference name

Example:

"1687-4"

employments.grade.description

string | null

description of the grade

Example:

"Mid-level employee demonstrating proficiency and autonomy."

employments.employment_type

object

deprecated

The type of employment (e.g., contractor, permanent)

Show child attributes

employments.employment_type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

employments.employment_type.source_value

Example:

"permanent"

employments.employment_contract_type

object

deprecated

The employment work schedule type (e.g., full-time, part-time)

Show child attributes

employments.employment_contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

employments.employment_contract_type.source_value

Example:

"full_time"

employments.type

object

The type of employment

Show child attributes

employments.type.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employments.type.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employments.type.label

string | null

The label of the employment type

Example:

"Permanent"

employments.type.type

object

The type of employment (e.g., contractor, permanent)

Show child attributes

employments.type.type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

employments.type.type.source_value

Example:

"permanent"

employments.contract_type

object

The employment work schedule type

Show child attributes

employments.contract_type.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employments.contract_type.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employments.contract_type.label

string | null

The label of the employment type

Example:

"Full-Time"

employments.contract_type.contract_type

object

The employment work schedule type (e.g., full-time, part-time)

Show child attributes

employments.contract_type.contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

employments.contract_type.contract_type.source_value

Example:

"full_time"

employments.work_time

object

Show child attributes

employments.work_time.duration

string<duration> | null

The work time duration in ISO 8601 duration format

Example:

"P0Y0M0DT8H0M0S"

employments.work_time.period

object

The period of the work time

Show child attributes

employments.work_time.period.value

enum<string> | null

The unified value for the period.

Available options:

day,

week,

month,

year,

unmapped_value,

Example:

"month"

employments.work_time.period.source_value

Example:

"month"

employments.payroll_code

string | null

The payroll code of the employee

Example:

"PC1"

employments.job_id

string | null

The employee job id

Example:

"5290"

employment

object

The employee employment

Show child attributes

employment.unified_custom_fields

object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

employment.job_title

string | null

The job title of the employee

Example:

"Software Engineer"

employment.pay_rate

string | null

The amount of compensation for the employee

Example:

"40.00"

employment.pay_period

object

The time period over which the pay rate is calculated

Show child attributes

employment.pay_period.value

enum<string> | null

Available options:

hour,

day,

week,

every_two_weeks,

month,

quarter,

every_six_months,

year,

unmapped_value,

employment.pay_period.source_value

Example:

"monthly"

employment.pay_frequency

object

How often the employee is paid

Show child attributes

employment.pay_frequency.value

enum<string> | null

Available options:

hourly,

weekly,

bi_weekly,

four_weekly,

semi_monthly,

monthly,

bi_monthly,

quarterly,

semi_annually,

yearly,

thirteen_monthly,

pro_rata,

unmapped_value,

half_yearly,

daily,

fixed,

employment.pay_frequency.source_value

Example:

"hourly"

employment.pay_currency

string | null

The currency used for pay

Example:

"USD"

employment.end_date

string<date-time> | null

The end date of employment

Example:

"2021-01-01T01:01:01.000Z"

employment.grade

object

Represents the employee’s position within the organizational hierarchy.

Show child attributes

employment.grade.id

string | null

The reference id

Example:

"1687-3"

employment.grade.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employment.grade.name

string | null

The reference name

Example:

"1687-4"

employment.grade.description

string | null

description of the grade

Example:

"Mid-level employee demonstrating proficiency and autonomy."

employment.employment_type

object

deprecated

The type of employment (e.g., contractor, permanent)

Show child attributes

employment.employment_type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

employment.employment_type.source_value

Example:

"permanent"

employment.employment_contract_type

object

deprecated

The employment work schedule type (e.g., full-time, part-time)

Show child attributes

employment.employment_contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

employment.employment_contract_type.source_value

Example:

"full_time"

employment.type

object

The type of employment

Show child attributes

employment.type.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employment.type.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employment.type.label

string | null

The label of the employment type

Example:

"Permanent"

employment.type.type

object

The type of employment (e.g., contractor, permanent)

Show child attributes

employment.type.type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

employment.type.type.source_value

Example:

"permanent"

employment.contract_type

object

The employment work schedule type

Show child attributes

employment.contract_type.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employment.contract_type.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

employment.contract_type.label

string | null

The label of the employment type

Example:

"Full-Time"

employment.contract_type.contract_type

object

The employment work schedule type (e.g., full-time, part-time)

Show child attributes

employment.contract_type.contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

employment.contract_type.contract_type.source_value

Example:

"full_time"

employment.work_time

object

Show child attributes

employment.work_time.duration

string<duration> | null

The work time duration in ISO 8601 duration format

Example:

"P0Y0M0DT8H0M0S"

employment.work_time.period

object

The period of the work time

Show child attributes

employment.work_time.period.value

enum<string> | null

The unified value for the period.

Available options:

day,

week,

month,

year,

unmapped_value,

Example:

"month"

employment.work_time.period.source_value

Example:

"month"

employment.payroll_code

string | null

The payroll code of the employee

Example:

"PC1"

employment.passthrough

object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

employment.effective_date

string<date-time> | null

deprecated

The employee effective date

Example:

"2021-01-01T00:00:00.000Z"

custom_fields

object[] | null

The employee custom fields

Show child attributes

custom_fields.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

custom_fields.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

custom_fields.value

The value associated with the custom field.

Example:

"Completed"

custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

custom_fields.remote_value_id

string | null

Provider's unique identifier for the value of the custom field.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

benefits

object[] | null

Current benefits of the employee

Show child attributes

benefits.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

benefits.name

string | null

The name of the benefit

Example:

"Health Insurance"

benefits.benefit_type

object

The type of the benefit

Show child attributes

benefits.benefit_type.value

enum<string> | null

The type of the benefit

Available options:

retirement_savings,

health_savings,

other,

health_insurance,

insurance,

unmapped_value,

benefits.benefit_type.source_value

benefits.provider

string | null

The provider of the benefit

Example:

"Aetna"

benefits.description

string | null

The description of the benefit

Example:

"Health insurance for employees"

benefits.created_at

string<date-time> | null

The date and time the benefit was created

Example:

"2021-01-01T00:00:00Z"

benefits.updated_at

string<date-time> | null

The date and time the benefit was last updated

Example:

"2021-01-01T00:00:00Z"

employee_number

string | null

The assigned employee number

Example:

"125"

national_identity_number

object

deprecated

The national identity number

Show child attributes

national_identity_number.value

string | null

Example:

"123456789"

national_identity_number.type

object

Show child attributes

national_identity_number.type.value

enum<string> | null

The type of the national identity number

Available options:

ssn,

nin,

sin,

nid,

pin,

pn,

umcn,

pic,

ric,

idnum,

cid,

nidnr,

pan,

aadhaar,

epic,

ptn,

itin,

tin,

uprc,

pcode,

ssi,

cedula,

passport,

voterid,

ntin,

bn,

fnr,

mva,

civil_id,

cnic,

nric,

fin,

uen,

registrationnumber,

nic,

personnummer,

ahv,

id,

eid,

va,

pid,

nrt,

nipt,

cbu,

cuit,

dni,

businessid,

vnr,

abn,

acn,

tfn,

jmbg,

bis,

insz,

nn,

egn,

pnf,

vat,

cnpj,

unp,

gst,

pst,

qst,

ni,

dic,

rc,

uid,

rut,

uscc,

cpf,

cpj,

cr,

stnr,

svnr,

ncf,

rnc,

nif,

ci,

ik,

kmkr,

registrikood,

tn,

ruc,

nit,

alv,

hetu,

ytunnus,

vn,

utr,

nifp,

amka,

cui,

nir,

siren,

siret,

tva,

oib,

hkid,

anum,

kennitala,

vsk,

npwp,

pps,

gstin,

idnr,

hr,

aic,

codicefiscale,

iva,

peid,

asmens,

pvm,

ctps,

vrn,

vtk,

int,

tk,

pas,

rne,

rg,

nci,

crnm,

pis,

insee,

tax,

mpf,

epfo,

esi,

pran,

uan,

idk,

bsn,

mid,

sss,

nie,

nss,

arc,

curp,

imss,

rfc,

ein,

other,

unknown,

unmapped_value,

Example:

"ssn"

national_identity_number.type.source_value

national_identity_number.country

object

The country code

Show child attributes

national_identity_number.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value,

Example:

"US"

national_identity_number.country.source_value

national_identity_numbers

object[] | null

The national identity numbers

Show child attributes

national_identity_numbers.value

string | null

Example:

"123456789"

national_identity_numbers.type

object

Show child attributes

national_identity_numbers.type.value

enum<string> | null

The type of the national identity number

Available options:

ssn,

nin,

sin,

nid,

pin,

pn,

umcn,

pic,

ric,

idnum,

cid,

nidnr,

pan,

aadhaar,

epic,

ptn,

itin,

tin,

uprc,

pcode,

ssi,

cedula,

passport,

voterid,

ntin,

bn,

fnr,

mva,

civil_id,

cnic,

nric,

fin,

uen,

registrationnumber,

nic,

personnummer,

ahv,

id,

eid,

va,

pid,

nrt,

nipt,

cbu,

cuit,

dni,

businessid,

vnr,

abn,

acn,

tfn,

jmbg,

bis,

insz,

nn,

egn,

pnf,

vat,

cnpj,

unp,

gst,

pst,

qst,

ni,

dic,

rc,

uid,

rut,

uscc,

cpf,

cpj,

cr,

stnr,

svnr,

ncf,

rnc,

nif,

ci,

ik,

kmkr,

registrikood,

tn,

ruc,

nit,

alv,

hetu,

ytunnus,

vn,

utr,

nifp,

amka,

cui,

nir,

siren,

siret,

tva,

oib,

hkid,

anum,

kennitala,

vsk,

npwp,

pps,

gstin,

idnr,

hr,

aic,

codicefiscale,

iva,

peid,

asmens,

pvm,

ctps,

vrn,

vtk,

int,

tk,

pas,

rne,

rg,

nci,

crnm,

pis,

insee,

tax,

mpf,

epfo,

esi,

pran,

uan,

idk,

bsn,

mid,

sss,

nie,

nss,

arc,

curp,

imss,

rfc,

ein,

other,

unknown,

unmapped_value,

Example:

"ssn"

national_identity_numbers.type.source_value

national_identity_numbers.country

object

The country code

Show child attributes

national_identity_numbers.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value,

Example:

"US"

national_identity_numbers.country.source_value

home_location

object

The employee home location

Show child attributes

home_location.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

home_location.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

home_location.phone_number

string | null

The phone number of the location

Example:

"+44 1476 860 364"

home_location.street_1

string | null

The first line of the address

Example:

"Water Lane"

home_location.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

home_location.city

string | null

The city where the location is situated

Example:

"Grantham"

home_location.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

home_location.country

object

The country code

Show child attributes

home_location.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value,

Example:

"US"

home_location.country.source_value

home_location.passthrough

object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

home_location.state

object

The ISO3166-2 sub division where the location is situated

Show child attributes

home_location.state.value

string | null

state (ISO3166-2 Sub Division Code) - value must be a valid enum value

home_location.state.source_value

Example:

"GB-LIN"

work_location

object

The employee work location

Show child attributes

work_location.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

work_location.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

work_location.phone_number

string | null

The phone number of the location

Example:

"+44 1476 860 364"

work_location.street_1

string | null

The first line of the address

Example:

"Water Lane"

work_location.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

work_location.city

string | null

The city where the location is situated

Example:

"Grantham"

work_location.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

work_location.country

object

The country code

Show child attributes

work_location.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value,

Example:

"US"

work_location.country.source_value

work_location.passthrough

object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

work_location.state

object

The ISO3166-2 sub division where the location is situated

Show child attributes

work_location.state.value

string | null

state (ISO3166-2 Sub Division Code) - value must be a valid enum value

work_location.state.source_value

Example:

"GB-LIN"

cost_centers

object[] | null

The employee cost centers

Show child attributes

cost_centers.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

cost_centers.name

string | null

Example:

"R&D"

cost_centers.distribution_percentage

number | null

Example:

100

passthrough

object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

Response

The employee was created successfully.

statusCode

number

required

Example:

201

message

string

required

Example:

"Record created successfully."

timestamp

string<date-time>

required

Example:

"2021-01-01T01:01:01.000Z"

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

Getting Started

Use Cases

API Reference

Authorizations

Headers

Body

Response