Skip to content
Get started

Dependents

Get dependent details
get/v1/dependents/{dependent_id}
Update dependent information
put/v1/dependents/{dependent_id}
ModelsExpand Collapse
Dependent = object { 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: boolean

Whether the dependent is currently active

created_at: string

Timestamp when the dependent was created

formatdate-time
date_of_birth: string

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: string

Timestamp when the dependent was last updated

formatdate-time
gender: optional string

Gender identity, if provided

ssn_last_four: optional string

Last 4 digits of SSN (masked)

suffix: optional string

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

Sex = "Male" or "Female" or "Other" or "Unknown"
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
Accepts one of the following:
"Male"
"Female"
"Other"
"Unknown"