The Dependent object

The Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an Employee

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
first_namestring or nullOptional<=60 characters
The dependents's first name.
middle_namestring or nullOptional<=60 characters
The dependents's middle name.
last_namestring or nullOptional<=60 characters
The dependents's last name.
relationshipenum or nullOptional

The dependent’s relationship to the employee.

  • CHILD - CHILD
  • SPOUSE - SPOUSE
  • DOMESTIC_PARTNER - DOMESTIC_PARTNER
Allowed values:
employeestring or nullOptionalformat: "uuid"
The employee this person is a dependent of.
date_of_birthdatetime or nullOptional
The dependent's date of birth.
genderenum or nullOptional

The dependent’s gender.

  • MALE - MALE
  • FEMALE - FEMALE
  • NON-BINARY - NON-BINARY
  • OTHER - OTHER
  • PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE
Allowed values:
phone_numberstring or nullOptional<=50 characters
The dependent's phone number.
home_locationstring or nullOptionalformat: "uuid"
The dependents's home address.
is_studentboolean or nullOptional
Whether or not the dependent is a student
ssnstring or nullOptional<=50 characters
The dependents's social security number.
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional
remote_datalist of objects or nullOptional