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

Members

MembersDependents

List member dependents
members.dependents.list(strmember_id, DependentListParams**kwargs) -> DependentListResponse
get/v1/members/{member_id}/dependents
Add new dependent
members.dependents.create(strmember_id, DependentCreateParams**kwargs) -> Dependent
post/v1/members/{member_id}/dependents
ModelsExpand Collapse
Relationship = Literal["Spouse", "Child"]
  • Spouse - Spouse
  • Child - Child
Accepts one of the following:
"Spouse"
"Child"

MembersQualifying Life Events

List member's qualifying life events
members.qualifying_life_events.list(strmember_id, QualifyingLifeEventListParams**kwargs) -> QualifyingLifeEventListResponse
get/v1/members/{member_id}/qualifying-life-events
Record qualifying life event
members.qualifying_life_events.record(strmember_id, QualifyingLifeEventRecordParams**kwargs) -> QualifyingLifeEvent
post/v1/members/{member_id}/qualifying-life-events
ModelsExpand Collapse
EventType = Literal["Marriage", "Birth", "Adoption", 8 more]
  • Marriage - Marriage
  • Birth - Birth
  • Adoption - Adoption
  • Divorce - Divorce
  • Death - Death
  • Job Loss - Job Loss
  • Reduction In Hours - Reduction In Hours
  • Employer Bankruptcy - Employer Bankruptcy
  • Medicare Entitlement - Medicare Entitlement
  • Termination - Termination
  • Other - Other
Accepts one of the following:
"Marriage"
"Birth"
"Adoption"
"Divorce"
"Death"
"Job Loss"
"Reduction In Hours"
"Employer Bankruptcy"
"Medicare Entitlement"
"Termination"
"Other"
class QualifyingLifeEvent: …

Serializer for Qualifying Life Event entity in public API responses.

QLEs are significant life changes (marriage, birth, adoption, loss of coverage) that allow employees to modify benefit elections outside of open enrollment.

id: str

Unique QLE identifier with 'qle_' prefix

created_at: datetime

Timestamp when the QLE was created

formatdate-time
employee_id: str

ID of the employee (empl_*)

enrollment_window_end: date

End of the special enrollment period (typically 30-60 days from event)

formatdate
enrollment_window_start: date

Start of the special enrollment period

formatdate
event_date: date

Date when the qualifying life event occurred

formatdate
event_type: str

Type of qualifying life event (e.g., 'marriage', 'birth', 'adoption', 'loss_of_coverage', 'divorce')

member_id: str

ID of the member experiencing the life event (mbr_*)

status: QualifyingLifeEventStatus
  • pending - Pending
  • approved - Approved
  • denied - Denied
Accepts one of the following:
"pending"
"approved"
"denied"
updated_at: datetime

Timestamp when the QLE was last updated

formatdate-time
notes: Optional[str]

Additional notes or comments about the QLE

reviewed_at: Optional[datetime]

Timestamp when the QLE was reviewed, if reviewed

formatdate-time
reviewed_by: Optional[str]

ID of the user who reviewed the QLE, if reviewed

QualifyingLifeEventStatus = Literal["pending", "approved", "denied"]
  • pending - Pending
  • approved - Approved
  • denied - Denied
Accepts one of the following:
"pending"
"approved"
"denied"