Request This endpoint expects an object.
first_name string Required
Must not be empty. NOTE: This field will be normalized according to our internal formatting rules.
last_name string Required
Must not be empty. NOTE: This field will be normalized according to our internal formatting rules.
date_of_birth date Required
Must be in the past, but after 1900-01-01
sex_at_birth enum Required
The sex assigned to the associated person at birth
Allowed values: male female
relationship_type enum Required
The relationship type between the employee and the associated person
Allowed values: spouse partner child other
email string or null Optional
NOTE: This field will be normalized according to our internal formatting rules.
phone_number string or null Optional
Phone number in E.164 international format (e.g. +447700900999). NOTE: This field will be normalized according to our internal formatting rules.
Response OK
id string format: "ap_.+"
Unique identifier for the associated person
employee_id string format: "ee_.+"
Unique identifier for the employee this person is associated with
first_name string
First name of the associated person
last_name string
Last name of the associated person
date_of_birth date
Date of birth of the associated person
sex_at_birth enum
The sex assigned to the associated person at birth
Allowed values: male female
relationship_type enum
The relationship type between the employee and the associated person
Allowed values: spouse partner child other
platform_id string format: "pt_.+"
Unique identifier for the platform
email string or null
Email address of the associated person
phone_number string or null
Phone number in E.164 international format (e.g. +447700900999)
object string Read-only
The object type
