/dependents/{id}
/dependents/{id}
Returns a Dependent object with the given id.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Path parameters
id
Headers
X-Account-Token
Token identifying the end user.
Query parameters
include_remote_data
Whether to include the original data Merge fetched from the third-party to produce these models.
include_sensitive_fields
Whether to include sensitive fields (such as social security numbers) in the response.
include_shell_data
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Response
id
remote_id
The third-party API ID of the matching object.
created_at
The datetime that this object was created by Merge.
modified_at
The datetime that this object was modified by Merge.
first_name
The dependents's first name.
middle_name
The dependents's middle name.
last_name
The dependents's last name.
relationship
The dependent's relationship to the employee.
Allowed values:
employee
The employee this person is a dependent of.
date_of_birth
The dependent's date of birth.
gender
The dependent's gender.
Allowed values:
phone_number
The dependent's phone number.
home_location
The dependents's home address.
is_student
Whether or not the dependent is a student
ssn
The dependents's social security number.
remote_was_deleted
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_mappings
remote_data