Skip to content

Relationships

Schema relationships
graph LR
    Dependents -->|"employee"| Employees
    Dependents -->|"home_location"| Locations

Properties

idstring
required·

The unique identifier for the dependent

created_atstring · date-time

The date and time the dependent was created

date_of_birthstring

The date of birth of the dependent, in YYYY-MM-DD format. Empty when the provider masks it.

emailsobject[]

The email addresses of the dependent

emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

employeeobject

The employee the dependent belongs to

References: Employees → id
idstring

The unique identifier for employees

namestring

The name of the employee

end_datestring · date-time

When the person stopped being a dependent of the employee. Empty while they still are

first_namestring

The first name of the dependent

genderstring

The gender of the dependent. Empty when the provider value fits none of these.

Possible values:
malefemalenon_binaryotherprefer_not_to_disclose
home_locationobject[]

The home addresses of the dependent. Most providers record a single address.

References: Locations → id
citystring

The city of the home address

countrystring

The country of the home address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the home address

statestring

The state/province of the home address

street_1string

The first line of home address

street_2string

The second line of home address

is_disabledboolean

Whether the dependent has a disability

is_studentboolean

Whether the dependent is a full-time student

is_tobacco_userboolean

Whether the dependent uses tobacco

last_namestring

The last name of the dependent

middle_namestring

The middle name of the dependent

namestring

The full name of the dependent

phonesobject[]

The phone numbers of the dependent

extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

relationshipstring

The dependent's relationship to the employee. Relationships that fit none of the other values, such as grandchild or legal guardian, are returned as other, and the provider's own label stays in remote_data. Registered or civil partnerships that the provider records separately from marriage are returned as domestic_partner.

Possible values:
spousedomestic_partnerchildstepchildfoster_childwardparentother
remote_dataRecord<string, any>

Raw data returned from the remote API call.

ssnstring

The social security number or national identifier of the dependent. Most providers return it masked.

start_datestring · date-time

When the person became a dependent of the employee, such as the relationship or coverage eligibility start date

statusstring

Whether the person is currently a dependent of the employee. inactive means they no longer are, for example after being removed from coverage. Empty when the provider does not say.

Possible values:
activeinactive
updated_atstring · date-time

The date and time the dependent was last updated