members.list_qualifying_life_events(member_id, **kwargs) -> PageNumberPage<MemberListQualifyingLifeEventsResponse { id, event_type, other_event, 2 more } >

GET/v1/members/{member_id}/qualifying-life-events

ModelsExpand Collapse

class MemberListResponse { id, first_name, last_name, 3 more }

A member in the organization’s directory: identity, contact details, address, and join date.

id: String

Unique member identifier with ‘mbr_’ prefix

first_name: String

Member’s legal first name

last_name: String

Member’s legal last name

address: { address_line_1, city, state, 2 more}

Member’s residential address

address_line_1: String

Primary street address

city: String

City name

state: :AL | :AK | :AZ | 59 more

AL - AL
AK - AK
AZ - AZ
AR - AR
CA - CA
CO - CO
CT - CT
DC - DC
DE - DE
FL - FL
GA - GA
HI - HI
ID - ID
IL - IL
IN - IN
IA - IA
KS - KS
KY - KY
LA - LA
ME - ME
MD - MD
MA - MA
MI - MI
MN - MN
MS - MS
MO - MO
MT - MT
NE - NE
NV - NV
NH - NH
NJ - NJ
NM - NM
NY - NY
NC - NC
ND - ND
OH - OH
OK - OK
OR - OR
PA - PA
RI - RI
SC - SC
SD - SD
TN - TN
TX - TX
UT - UT
VT - VT
VA - VA
WA - WA
WI - WI
WV - WV
WY - WY
PR - PR
GU - GU
AS - AS
VI - VI
MP - MP
MH - MH
PW - PW
FM - FM
AE - AE
AA - AA
AP - AP

One of the following:

:AL

:AK

:AZ

:AR

:CA

:CO

:CT

:DC

:DE

:FL

:GA

:HI

:ID

:IL

:IN

:IA

:KS

:KY

:LA

:ME

:MD

:MA

:MI

:MN

:MS

:MO

:MT

:NE

:NV

:NH

:NJ

:NM

:NY

:NC

:ND

:OH

:OK

:OR

:PA

:RI

:SC

:SD

:TN

:TX

:UT

:VT

:VA

:WA

:WI

:WV

:WY

:PR

:GU

:AS

:VI

:MP

:MH

:PW

:FM

:AE

:AA

:AP

zipcode: String

ZIP code (5 or 9 digit)

address_line_2: String

Secondary street address (apt, suite, etc.)

email: String

Email address

formatemail

phone: String

Phone number (10-digit US domestic string)

class MemberRetrieveResponse { data }

Response containing a single member resource.

data: { id, age, date_of_birth, 14 more}

A member’s profile: identity, contact details, address, demographics, and onboarding status.

id: String

Unique member identifier with ‘mbr_’ prefix

age: Integer

Member’s age in years, derived from date of birth

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

first_name: String

Member’s legal first name

last_name: String

Member’s legal last name

name: String

Member’s full legal name

status: :onboarded | :pending_onboarding

Member profile status (onboarded or pending onboarding)

One of the following:

:onboarded

:pending_onboarding

address: { address_line_1, city, state, 2 more}

Member’s residential address

address_line_1: String

Primary street address

city: String

City name

state: :AL | :AK | :AZ | 59 more

AL - AL
AK - AK
AZ - AZ
AR - AR
CA - CA
CO - CO
CT - CT
DC - DC
DE - DE
FL - FL
GA - GA
HI - HI
ID - ID
IL - IL
IN - IN
IA - IA
KS - KS
KY - KY
LA - LA
ME - ME
MD - MD
MA - MA
MI - MI
MN - MN
MS - MS
MO - MO
MT - MT
NE - NE
NV - NV
NH - NH
NJ - NJ
NM - NM
NY - NY
NC - NC
ND - ND
OH - OH
OK - OK
OR - OR
PA - PA
RI - RI
SC - SC
SD - SD
TN - TN
TX - TX
UT - UT
VT - VT
VA - VA
WA - WA
WI - WI
WV - WV
WY - WY
PR - PR
GU - GU
AS - AS
VI - VI
MP - MP
MH - MH
PW - PW
FM - FM
AE - AE
AA - AA
AP - AP

One of the following:

:AL

:AK

:AZ

:AR

:CA

:CO

:CT

:DC

:DE

:FL

:GA

:HI

:ID

:IL

:IN

:IA

:KS

:KY

:LA

:ME

:MD

:MA

:MI

:MN

:MS

:MO

:MT

:NE

:NV

:NH

:NJ

:NM

:NY

:NC

:ND

:OH

:OK

:OR

:PA

:RI

:SC

:SD

:TN

:TX

:UT

:VT

:VA

:WA

:WI

:WV

:WY

:PR

:GU

:AS

:VI

:MP

:MH

:PW

:FM

:AE

:AA

:AP

zipcode: String

ZIP code (5 or 9 digit)

address_line_2: String

Secondary street address (apt, suite, etc.)

email: String

Email address

formatemail

gender: :Male | :Female | :Transgender | 2 more

Male - Male
Female - Female
Transgender - Transgender
Non-binary - Non Binary
Prefer not to respond - Prefer Not To Respond

One of the following:

:Male

:Female

:Transgender

:"Non-binary"

:"Prefer not to respond"

marital_status: :Single | :Married

Single - Single
Married - Married

One of the following:

:Single

:Married

middle_name: String

Member’s legal middle name

phone: String

Phone number (10-digit US domestic string)

preferred_language: :en | :es | :zh | 3 more

en - English
es - Spanish
zh - Chinese
ru - Russian
sw - Swahili
th - Thai

One of the following:

:en

:es

:zh

:ru

:sw

:th

sex_at_birth: :Male | :Female | :Other | :Unknown

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

One of the following:

:Male

:Female

:Other

:Unknown

suffix: :Sr | :Jr | :I | 4 more

Sr - Sr
Jr - Jr
I - I
II - II
III - III
IV - IV
V - V

One of the following:

:Sr

:Jr

:II

:III

:IV

tobacco_status: bool

Whether the member uses tobacco, if known

class MemberListDependentsResponse { data }

Unpaginated {"data": [...]} list of member dependents.

data: Array[{ age, date_of_birth, first_name, 5 more}]

age: Integer

Dependent’s age in years, derived from date of birth

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

first_name: String

Dependent’s first name

last_name: String

Dependent’s last name

member_id: String

The dependent’s own member identifier with ‘mbr_’ prefix

primary_member_id: String

The primary member’s identifier with ‘mbr_’ prefix

relationship: :Spouse | :Child

Spouse - Spouse
Child - Child

One of the following:

:Spouse

:Child

sex_at_birth: :Male | :Female | :Other | :Unknown

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

One of the following:

:Male

:Female

:Other

:Unknown

class MemberListEmploymentsResponse { data }

Unpaginated {"data": [...]} list of member employments.

data: Array[Employee { id, classification_effective_date, compensation_type, 20 more } ]

id: String

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: Date

Date the employee’s current classification took effect

formatdate

compensation_type: :Salary | :Hourly

Salary - Salary
Hourly - Hourly

One of the following:

:Salary

:Hourly

compensation_type_effective_date: Date

Date the employee’s current compensation type took effect

formatdate

created_at: Time

Timestamp when the employee was created

formatdate-time

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array[{ benefit_name, deduction_amount_in_cents, deduction_category, 4 more}]

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: String

Name of the benefit plan

deduction_amount_in_cents: Integer

Employee deduction amount in cents

deduction_category: String

Deduction category (reserved for future use)

frequency: :weekly | :bi_weekly | :semi_monthly | :monthly

weekly - Weekly
bi_weekly - Bi Weekly
semi_monthly - Semi Monthly
monthly - Monthly

One of the following:

:weekly

:bi_weekly

:semi_monthly

:monthly

period_end_date: Date

Period end date (YYYY-MM-DD)

formatdate

period_start_date: Date

Period start date (YYYY-MM-DD)

formatdate

tax_classification: :Unknown | :"Pre-tax" | :"Post-tax"

Unknown - Unknown
Pre-tax - Pre Tax
Post-tax - Post Tax

One of the following:

:Unknown

:"Pre-tax"

:"Post-tax"

email: String

Email address

formatemail

employee_class: EmployeeClass

Full Time - Full Time
Part Time - Part Time
Temporary - Temporary
Intern - Intern
Seasonal - Seasonal
Individual Contractor - Individual Contractor

One of the following:

:"Full Time"

:"Part Time"

:Temporary

:Intern

:Seasonal

:"Individual Contractor"

employer_id: String

Unique identifier of the employer this employment is with (empr_*)

first_name: String

Employee’s legal first name

last_name: String

Employee’s legal last name

member_id: String

Unique member identifier with ‘mbr_’ prefix

phone: String

Phone number (10-digit US domestic string)

start_date: Date

Employee’s start date with the employer

formatdate

status: :active | :terminated

Employee status (active or terminated)

One of the following:

:active

:terminated

updated_at: Time

Timestamp when the employee was last updated

formatdate-time

address: { address_line_1, city, state, 2 more}

Employee’s residential address

address_line_1: String

Primary street address

city: String

City name

state: String

Two-letter state code (e.g., CA, NY)

zipcode: String

ZIP code (5 or 9 digit)

address_line_2: String

Secondary street address (apt, suite, etc.)

employer_name: String

Name of the employer this employment is with

gender: String

Gender identity, if provided

reference_id: String

Partner-assigned reference ID for the employee

suffix: String

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

termination_date: Date

Employee’s termination date, if terminated

formatdate

class MemberListEnrollmentsResponse { data }

Unpaginated {"data": [...]} list of member enrollments.

data: Array[{ id, benefit_plan_year_id, benefit_type, 21 more}]

id: String

Opaque, stable enrollment identifier used to target enrollment actions

benefit_plan_year_id: String

Exact benefit plan-year identifier for this enrollment

benefit_type: :Medical | :Dental | :Vision | :Hospital

Medical - Medical
Dental - Dental
Vision - Vision
Hospital - Hospital

One of the following:

:Medical

:Dental

:Vision

:Hospital

cancelled_date: Date

Earliest applicable coverage boundary (YYYY-MM-DD) when coverage was cancelled before its effective start; null unless the enrollment was cancelled

formatdate

election_status: :Enrolled | :Waived | :Pending | :Expired

Enrolled - Enrolled
Waived - Waived
Pending - Pending
Expired - Expired

One of the following:

:Enrolled

:Waived

:Pending

:Expired

employer_id: String

Exact employer identifier for this enrollment

employer_name: String

Name of the employer the enrollment is through

enrollment_window_start: Date

Enrollment / open-enrollment window start date (YYYY-MM-DD)

formatdate

in_last_month_of_coverage: bool

True when today falls in the final month of the plan-year coverage window; drives end-of-coverage enrollment actions on the client.

is_within_enrollment_window: bool

True when today falls inside the enrollment window this member has to answer in; drives enrollment-action availability on the client.

plan_year_coverage_end: Date

Benefit plan-year coverage end date (YYYY-MM-DD), distinct from this enrollment’s coverage_end; null when the plan year is open-ended

formatdate

policy_status: :"Coverage Upcoming" | :"Coverage Effective" | :"Coverage Ended" | :Cancelled

Coverage Upcoming - Coverage Upcoming
Coverage Effective - Coverage Effective
Coverage Ended - Coverage Ended
Cancelled - Cancelled

One of the following:

:"Coverage Upcoming"

:"Coverage Effective"

:"Coverage Ended"

:Cancelled

product_code: :EBA | :VPC | :VPC_CORE | 12 more

EBA - Eba Mec
VPC - Vpc Enhanced
VPC_CORE - Vpc Core
MEC - Vpc Mec
MEC2 - Mec2
MEC_PLUS - Mec Plus
MVP - Mvp
MVP2 - Mvp2
MVPSL - Mvpsl
MVPSL2 - Mvpsl2
VD - Dental
VV - Vision
ICHRA - Ichra
ICHRA_PREMIUM_PLUS - Ichra Premium Plus
ICHRA_REIMBURSEMENT_ONLY - Ichra Reimbursement Only

One of the following:

:EBA

:VPC

:VPC_CORE

:MEC

:MEC2

:MEC_PLUS

:MVP

:MVP2

:MVPSL

:MVPSL2

:VD

:VV

:ICHRA

:ICHRA_PREMIUM_PLUS

:ICHRA_REIMBURSEMENT_ONLY

product_name: String

Display name of the benefit product

requires_qle_for_reissue: bool

Whether a qualifying life event would be required to reissue this enrollment under the product and open-enrollment rule at the time this list was read

carrier_name: String

Insurance carrier name; null when no active carrier period is resolvable

coverage_end: Date

Coverage window end date (YYYY-MM-DD); null while coverage is open-ended

formatdate

coverage_start: Date

Coverage window start date (YYYY-MM-DD)

formatdate

employee_deduction_in_cents: Integer

Employee monthly payroll deduction in cents; null unless the row is an election

employer_contribution_in_cents: Integer

Employer monthly contribution in cents; null unless the row is an election

enrollment_window_end: Date

Enrollment / open-enrollment window end date (YYYY-MM-DD); null when open-ended

formatdate

plan_name: String

Chosen benefit plan name; null unless the row is an election

premium_in_cents: Integer

Total monthly plan premium in cents; null unless the row is an election

tier_name: String

Chosen benefit plan tier name (e.g., Employee Only); null unless the row is an election

class MemberRetrieveHouseholdResponse { data }

Unpaginated {"data": [...]} list of the members of a member’s household.

data: Array[{ date_of_birth, first_name, household_admin_in, 4 more}]

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

first_name: String

Household member’s first name

household_admin_in: bool

Whether this participant is a household admin (the account holder always is)

last_name: String

Household member’s last name

member_id: String

Member identifier with ‘mbr_’ prefix

member_type: :"Account Holder" | :Dependent | :Inactive

Account Holder - Account Holder
Dependent - Dependent
Inactive - Inactive

One of the following:

:"Account Holder"

:Dependent

:Inactive

relationship: :Child | :Spouse | :Roommate | :Other

Child - Child
Spouse - Spouse
Roommate - Roommate
Other - Other

One of the following:

:Child

:Spouse

:Roommate

:Other

class MemberListIDCardsResponse { data }

Unpaginated {"data": [...]} list of member digital benefit cards.

data: Array[{ card_type, group_id, group_member_id, 11 more}]

card_type: :medical | :dental | :vision | :rx

medical - medical
dental - dental
vision - vision
rx - rx

One of the following:

:medical

:dental

:vision

:rx

group_id: String

Group number printed on the card (the rx group id for an rx card)

group_member_id: String

Member id printed on the card (the Ventegra cardholder id for an rx card)

member_name: String

Name of the member the card is issued to

nsa_table: Array[Array[String]]

No Surprises Act cost-sharing table rendered on the card; empty for an rx card

benefit_code: :EBA | :VPC | :VPC_CORE | 12 more

EBA - Eba Mec
VPC - Vpc Enhanced
VPC_CORE - Vpc Core
MEC - Vpc Mec
MEC2 - Mec2
MEC_PLUS - Mec Plus
MVP - Mvp
MVP2 - Mvp2
MVPSL - Mvpsl
MVPSL2 - Mvpsl2
VD - Dental
VV - Vision
ICHRA - Ichra
ICHRA_PREMIUM_PLUS - Ichra Premium Plus
ICHRA_REIMBURSEMENT_ONLY - Ichra Reimbursement Only

One of the following:

:EBA

:VPC

:VPC_CORE

:MEC

:MEC2

:MEC_PLUS

:MVP

:MVP2

:MVPSL

:MVPSL2

:VD

:VV

:ICHRA

:ICHRA_PREMIUM_PLUS

:ICHRA_REIMBURSEMENT_ONLY

carrier_phone: String

Carrier phone number on the card; null for an rx card

carrier_website: String

Carrier website on the card; null for an rx card

claims_payer_display_name: String

Claims payer shown on the card

employer_name: String

Employer the card’s coverage is through; null for an rx card without group info

general_disclaimer: String

General disclaimer text; null for an rx card

network: { id, address, logo, 8 more}

Provider network shown on the card; null for an rx card

id: String

formatuuid

address: { address_line_1, address_line_2, city, 2 more}

Shared read serializer for a postal address on public API responses.

One definition for the address block every public resource emits (employer, employee, …), so the 5-field shape isn’t hand-rolled per endpoint. Read-only: it renders an already-built address value object (e.g. AddressDVO) whose attributes map 1:1 to these fields.

address_line_1: String

Primary street address.

address_line_2: String

Secondary street address (apt, suite, etc.).

city: String

City name.

state: String

Two-letter state code (e.g. CA, NY).

zipcode: String

ZIP code (5 or 9 digit).

logo: String

member_phone: String

name: String

Name of the network

maxLength256

phone: String

provider_phone: String

website: String

Website of the network

maxLength256

edi: String

Network’s EDI

maxLength128

member_website: String

Website for members

maxLength256

provider_website: String

Website for providers

maxLength256

plan_disclaimer: String

Plan-specific disclaimer text; null for an rx card

plan_name: String

Benefit plan name on the card; null for a consumer-membership rx card

class MemberListQualifyingLifeEventsResponse { id, event_type, other_event, 2 more }

id: String

Opaque qualifying life event identifier

event_type: :Married | :Divorced | :"New child" | 2 more

Married - Married
Divorced - Divorced
New child - New Child
Court ordered - Court Ordered
Other - Other

One of the following:

:Married

:Divorced

:"New child"

:"Court ordered"

:Other

other_event: String

Custom event description when event_type is Other; otherwise normally null

status: :pending | :approved | :denied

pending - Pending
approved - Approved
denied - Denied

One of the following:

:pending

:approved

:denied

submitted_at: Time

When the member submitted the event

formatdate-time