Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Members

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

List members
members.list(MemberListParams**kwargs) -> SyncPageNumberPage[MemberListResponse]
GET/v2/members
Get member
members.retrieve(strmember_id) -> MemberRetrieveResponse
GET/v1/members/{member_id}
List member dependents
members.list_dependents(strmember_id) -> MemberListDependentsResponse
GET/v1/members/{member_id}/dependents
List member employments
members.list_employments(strmember_id) -> MemberListEmploymentsResponse
GET/v1/members/{member_id}/employments
List member enrollments
members.list_enrollments(strmember_id) -> MemberListEnrollmentsResponse
GET/v1/members/{member_id}/enrollments
Get member household
members.retrieve_household(strmember_id) -> MemberRetrieveHouseholdResponse
GET/v1/members/{member_id}/household
List member ID cards
members.list_id_cards(strmember_id) -> MemberListIDCardsResponse
GET/v1/members/{member_id}/id-cards
List member qualifying life events
members.list_qualifying_life_events(strmember_id, MemberListQualifyingLifeEventsParams**kwargs) -> SyncPageNumberPage[MemberListQualifyingLifeEventsResponse]
GET/v1/members/{member_id}/qualifying-life-events
ModelsExpand Collapse
class MemberListResponse: …

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

id: str

Unique member identifier with ‘mbr_’ prefix

first_name: str

Member’s legal first name

last_name: str

Member’s legal last name

address: Optional[Address]

Member’s residential address

address_line_1: str

Primary street address

city: str

City name

state: Literal["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: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

email: Optional[str]

Email address

formatemail
phone: Optional[str]

Phone number (10-digit US domestic string)

class MemberRetrieveResponse: …

Response containing a single member resource.

data: Data

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

id: str

Unique member identifier with ‘mbr_’ prefix

age: int

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

date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
first_name: str

Member’s legal first name

last_name: str

Member’s legal last name

name: str

Member’s full legal name

status: Literal["onboarded", "pending_onboarding"]

Member profile status (onboarded or pending onboarding)

One of the following:
"onboarded"
"pending_onboarding"
address: Optional[DataAddress]

Member’s residential address

address_line_1: str

Primary street address

city: str

City name

state: Literal["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: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

email: Optional[str]

Email address

formatemail
gender: Optional[Literal["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: Optional[Literal["Single", "Married"]]
  • Single - Single
  • Married - Married
One of the following:
"Single"
"Married"
middle_name: Optional[str]

Member’s legal middle name

phone: Optional[str]

Phone number (10-digit US domestic string)

preferred_language: Optional[Literal["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: Optional[Literal["Male", "Female", "Other", "Unknown"]]
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
One of the following:
"Male"
"Female"
"Other"
"Unknown"
suffix: Optional[Literal["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"
"I"
"II"
"III"
"IV"
"V"
tobacco_status: Optional[bool]

Whether the member uses tobacco, if known

class MemberListDependentsResponse: …

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

data: List[Data]
age: int

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

date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
first_name: str

Dependent’s first name

last_name: str

Dependent’s last name

member_id: str

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

primary_member_id: str

The primary member’s identifier with ‘mbr_’ prefix

relationship: Literal["Spouse", "Child"]
  • Spouse - Spouse
  • Child - Child
One of the following:
"Spouse"
"Child"
sex_at_birth: Optional[Literal["Male", "Female", "Other", "Unknown"]]
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
One of the following:
"Male"
"Female"
"Other"
"Unknown"
class MemberListEmploymentsResponse: …

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

data: List[Employee]
id: str

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: date

Date the employee’s current classification took effect

formatdate
compensation_type: Optional[Literal["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: datetime

Timestamp when the employee was created

formatdate-time
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
deductions: List[Deduction]

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

benefit_name: str

Name of the benefit plan

deduction_amount_in_cents: int

Employee deduction amount in cents

deduction_category: Optional[str]

Deduction category (reserved for future use)

frequency: Literal["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: Literal["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: str

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

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

first_name: str

Employee’s legal first name

last_name: str

Employee’s legal last name

member_id: str

Unique member identifier with ‘mbr_’ prefix

phone: Optional[str]

Phone number (10-digit US domestic string)

start_date: date

Employee’s start date with the employer

formatdate
status: Literal["active", "terminated"]

Employee status (active or terminated)

One of the following:
"active"
"terminated"
updated_at: datetime

Timestamp when the employee was last updated

formatdate-time
address: Optional[Address]

Employee’s residential address

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

employer_name: Optional[str]

Name of the employer this employment is with

gender: Optional[str]

Gender identity, if provided

reference_id: Optional[str]

Partner-assigned reference ID for the employee

suffix: Optional[str]

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

termination_date: Optional[date]

Employee’s termination date, if terminated

formatdate
class MemberListEnrollmentsResponse: …

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

data: List[Data]
id: str

Opaque, stable enrollment identifier used to target enrollment actions

benefit_plan_year_id: str

Exact benefit plan-year identifier for this enrollment

benefit_type: Literal["Medical", "Dental", "Vision", "Hospital"]
  • Medical - Medical
  • Dental - Dental
  • Vision - Vision
  • Hospital - Hospital
One of the following:
"Medical"
"Dental"
"Vision"
"Hospital"
cancelled_date: Optional[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: Literal["Enrolled", "Waived", "Pending", "Expired"]
  • Enrolled - Enrolled
  • Waived - Waived
  • Pending - Pending
  • Expired - Expired
One of the following:
"Enrolled"
"Waived"
"Pending"
"Expired"
employer_id: str

Exact employer identifier for this enrollment

employer_name: str

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: Optional[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: Optional[Literal["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: Literal["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: str

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: Optional[str]

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

coverage_end: Optional[date]

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

formatdate
coverage_start: Optional[date]

Coverage window start date (YYYY-MM-DD)

formatdate
employee_deduction_in_cents: Optional[int]

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

employer_contribution_in_cents: Optional[int]

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

enrollment_window_end: Optional[date]

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

formatdate
plan_name: Optional[str]

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

premium_in_cents: Optional[int]

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

tier_name: Optional[str]

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

class MemberRetrieveHouseholdResponse: …

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

data: List[Data]
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
first_name: str

Household member’s first name

household_admin_in: bool

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

last_name: str

Household member’s last name

member_id: str

Member identifier with ‘mbr_’ prefix

member_type: Literal["Account Holder", "Dependent", "Inactive"]
  • Account Holder - Account Holder
  • Dependent - Dependent
  • Inactive - Inactive
One of the following:
"Account Holder"
"Dependent"
"Inactive"
relationship: Optional[Literal["Child", "Spouse", "Roommate", "Other"]]
  • Child - Child
  • Spouse - Spouse
  • Roommate - Roommate
  • Other - Other
One of the following:
"Child"
"Spouse"
"Roommate"
"Other"
class MemberListIDCardsResponse: …

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

data: List[Data]
card_type: Literal["medical", "dental", "vision", "rx"]
  • medical - medical
  • dental - dental
  • vision - vision
  • rx - rx
One of the following:
"medical"
"dental"
"vision"
"rx"
group_id: str

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

group_member_id: str

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

member_name: str

Name of the member the card is issued to

nsa_table: List[List[str]]

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

benefit_code: Optional[Literal["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: Optional[str]

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

carrier_website: Optional[str]

Carrier website on the card; null for an rx card

claims_payer_display_name: Optional[str]

Claims payer shown on the card

employer_name: Optional[str]

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

general_disclaimer: Optional[str]

General disclaimer text; null for an rx card

network: Optional[DataNetwork]

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

id: str
formatuuid
address: DataNetworkAddress

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

Primary street address.

address_line_2: Optional[str]

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

city: str

City name.

state: str

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

zipcode: str

ZIP code (5 or 9 digit).

member_phone: Optional[str]
name: str

Name of the network

maxLength256
phone: str
provider_phone: Optional[str]
website: str

Website of the network

maxLength256
edi: Optional[str]

Network’s EDI

maxLength128
member_website: Optional[str]

Website for members

maxLength256
provider_website: Optional[str]

Website for providers

maxLength256
plan_disclaimer: Optional[str]

Plan-specific disclaimer text; null for an rx card

plan_name: Optional[str]

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

class MemberListQualifyingLifeEventsResponse: …
id: str

Opaque qualifying life event identifier

event_type: Literal["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: Optional[str]

Custom event description when event_type is Other; otherwise normally null

status: Literal["pending", "approved", "denied"]
  • pending - Pending
  • approved - Approved
  • denied - Denied
One of the following:
"pending"
"approved"
"denied"
submitted_at: datetime

When the member submitted the event

formatdate-time