Common ModelsDependents

/dependents/{id}

Returns a Dependent object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_sensitive_fieldsbooleanOptional

Whether to include sensitive fields (such as social security numbers) in the response.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
first_namestring or null<=60 characters
The dependents's first name.
middle_namestring or null<=60 characters
The dependents's middle name.
last_namestring or null<=60 characters
The dependents's last name.
relationshipenum or null

The dependent’s relationship to the employee.

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

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 null<=50 characters
The dependent's phone number.
home_locationstring or nullformat: "uuid"
The dependents's home address.
is_studentboolean or null
Whether or not the dependent is a student
ssnstring or null<=50 characters
The dependents's social security number.
remote_was_deletedbooleanRead-only

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 nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information