Members

Browse the members covered across your book and read a member’s profile

List members

client.members.list(?, ?): PageNumberPage<MemberListResponse { id, first_name, last_name, 3 more } >

GET/v2/members

Get member

client.members.retrieve(, ?): MemberRetrieveResponse { data }

GET/v1/members/{member_id}

List member dependents

client.members.listDependents(, ?): MemberListDependentsResponse { data }

GET/v1/members/{member_id}/dependents

List member employments

client.members.listEmployments(, ?): MemberListEmploymentsResponse { data }

GET/v1/members/{member_id}/employments

List member enrollments

client.members.listEnrollments(, ?): MemberListEnrollmentsResponse { data }

GET/v1/members/{member_id}/enrollments

Get member household

client.members.retrieveHousehold(, ?): MemberRetrieveHouseholdResponse { data }

GET/v1/members/{member_id}/household

List member ID cards

client.members.listIDCards(, ?): MemberListIDCardsResponse { data }

GET/v1/members/{member_id}/id-cards

List member qualifying life events

client.members.listQualifyingLifeEvents(, ?, ?): PageNumberPage<MemberListQualifyingLifeEventsResponse { id, event_type, other_event, 2 more } >

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

ModelsExpand Collapse

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 | null

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 | null

Secondary street address (apt, suite, etc.)

email?: string | null

Email address

formatemail

phone?: string | null

Phone number (10-digit US domestic string)

MemberRetrieveResponse { data }

Response containing a single member resource.

data: 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: number

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

date_of_birth: string

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 | null

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 | null

Secondary street address (apt, suite, etc.)

email?: string | null

Email address

formatemail

gender?: "Male" | "Female" | "Transgender" | 2 more | null

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" | null

Single - Single
Married - Married

One of the following:

"Single"

"Married"

middle_name?: string | null

Member’s legal middle name

phone?: string | null

Phone number (10-digit US domestic string)

preferred_language?: "en" | "es" | "zh" | 3 more | null

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" | null

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

One of the following:

"Male"

"Female"

"Other"

"Unknown"

suffix?: "Sr" | "Jr" | "I" | 4 more | null

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

One of the following:

"Sr"

"Jr"

"I"

"II"

"III"

"IV"

"V"

tobacco_status?: boolean | null

Whether the member uses tobacco, if known

MemberListDependentsResponse { data }

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

data: Array<Data>

age: number

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

date_of_birth: string

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" | null

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

One of the following:

"Male"

"Female"

"Other"

"Unknown"

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

Date the employee’s current classification took effect

formatdate

compensation_type: "Salary" | "Hourly" | null

Salary - Salary
Hourly - Hourly

One of the following:

"Salary"

"Hourly"

compensation_type_effective_date: string

Date the employee’s current compensation type took effect

formatdate

created_at: string

Timestamp when the employee was created

formatdate-time

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

deductions: Array<Deduction>

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

Employee deduction amount in cents

deduction_category: string | null

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

Period end date (YYYY-MM-DD)

formatdate

period_start_date: string

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 | null

Phone number (10-digit US domestic string)

start_date: string

Employee’s start date with the employer

formatdate

status: "active" | "terminated"

Employee status (active or terminated)

One of the following:

"active"

"terminated"

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address?: Address | null

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 | null

Secondary street address (apt, suite, etc.)

employer_name?: string | null

Name of the employer this employment is with

gender?: string | null

Gender identity, if provided

reference_id?: string | null

Partner-assigned reference ID for the employee

suffix?: string | null

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

termination_date?: string | null

Employee’s termination date, if terminated

formatdate

MemberListEnrollmentsResponse { data }

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

data: Array<Data>

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

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

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

formatdate

in_last_month_of_coverage: boolean

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

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

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" | null

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

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 | null

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

coverage_end?: string | null

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

formatdate

coverage_start?: string | null

Coverage window start date (YYYY-MM-DD)

formatdate

employee_deduction_in_cents?: number | null

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

employer_contribution_in_cents?: number | null

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

enrollment_window_end?: string | null

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

formatdate

plan_name?: string | null

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

premium_in_cents?: number | null

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

tier_name?: string | null

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

MemberRetrieveHouseholdResponse { data }

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

data: Array<Data>

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

first_name: string

Household member’s first name

household_admin_in: boolean

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" | null

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

One of the following:

"Child"

"Spouse"

"Roommate"

"Other"

MemberListIDCardsResponse { data }

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

data: Array<Data>

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 | null

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 | null

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

carrier_website?: string | null

Carrier website on the card; null for an rx card

claims_payer_display_name?: string | null

Claims payer shown on the card

employer_name?: string | null

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

general_disclaimer?: string | null

General disclaimer text; null for an rx card

network?: Network | null

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

id: string

formatuuid

address: 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 | null

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 | null

member_phone: string | null

name: string

Name of the network

maxLength256

phone: string

provider_phone: string | null

website: string

Website of the network

maxLength256

edi?: string | null

Network’s EDI

maxLength128

member_website?: string | null

Website for members

maxLength256

provider_website?: string | null

Website for providers

maxLength256

plan_disclaimer?: string | null

Plan-specific disclaimer text; null for an rx card

plan_name?: string | null

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

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 | null

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

When the member submitted the event

formatdate-time