Dependents

Get dependent details

dependents.retrieve(dependent_id) -> Dependent { id, active, created_at, 10 more }

get/v1/dependents/{dependent_id}

Update dependent information

dependents.update(dependent_id, **kwargs) -> Dependent { id, active, created_at, 10 more }

put/v1/dependents/{dependent_id}

ModelsExpand Collapse

class Dependent { id, active, created_at, 10 more }

Serializer for Dependent entity in public API responses.

Dependents are family members (spouse, children) who may be eligible for benefit coverage through an employee.

id: String

Unique dependent identifier with 'dpnd_' prefix

active: bool

Whether the dependent is currently active

created_at: Time

Timestamp when the dependent was created

formatdate-time

date_of_birth: Date

Dependent's date of birth (YYYY-MM-DD)

formatdate

first_name: String

Dependent's legal first name

last_name: String

Dependent's legal last name

member_id: String

ID of the primary member/employee (mbr_*)

relationship: Relationship

Spouse - Spouse
Child - Child

Accepts one of the following:

:Spouse

:Child

sex: Sex

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

:Male

:Female

:Other

:Unknown

updated_at: Time

Timestamp when the dependent was last updated

formatdate-time

gender: String

Gender identity, if provided

ssn_last_four: String

Last 4 digits of SSN (masked)

suffix: String

Name suffix (e.g., Jr., Sr., III)

Sex = :Male | :Female | :Other | :Unknown

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

:Male

:Female

:Other

:Unknown