Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference

Dependents

Get dependent details
dependents.retrieve(strdependent_id) -> Dependent
get/v1/dependents/{dependent_id}
Update dependent information
dependents.update(strdependent_id, DependentUpdateParams**kwargs) -> Dependent
put/v1/dependents/{dependent_id}
ModelsExpand Collapse
class Dependent: …

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

Unique dependent identifier with 'dpnd_' prefix

active: bool

Whether the dependent is currently active

created_at: datetime

Timestamp when the dependent was created

formatdate-time
date_of_birth: date

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

formatdate
first_name: str

Dependent's legal first name

last_name: str

Dependent's legal last name

member_id: str

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

Timestamp when the dependent was last updated

formatdate-time
gender: Optional[str]

Gender identity, if provided

ssn_last_four: Optional[str]

Last 4 digits of SSN (masked)

suffix: Optional[str]

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

Sex = Literal["Male", "Female", "Other", "Unknown"]
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
Accepts one of the following:
"Male"
"Female"
"Other"
"Unknown"