Groups
- POSTCreate Group
- PUTEdit Group
- GETGet Group
- GETList Groups
- Configurations
- Connections
- Contacts
- Disconnections
- Enrollments
- Locations
- Plans
- Renewals
- Syncs
Members
- Employees
- Dependents
- Enrollments
- Premiums
Changes
Legacy
- Requests
- Transactions
Get CalculatedMember Snapshot for Employee
Get a Member Snapshot by Employee ID. This will be calculated based on the current state of Noyo data for the employee.
curl --request GET \
--url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_snapshot{
"coverages": [
{
"carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
"enrolled_members": [
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
"individual_type": "employee",
"latest_change_effective_date": "2022-02-13"
},
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
"individual_type": "dependent"
}
],
"line_of_coverage": "medical",
"plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9",
"signature_date": "2021-12-23"
},
{
"carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
"enrolled_members": [
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_type": "employee"
},
{
"effective_end_date": "2021-12-31",
"effective_start_date": "2022-01-01",
"individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
"individual_type": "dependent"
}
],
"line_of_coverage": "dental",
"plan_name": "DHMO Smile Plus",
"signature_date": "2021-12-23"
},
{
"carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
"enrolled_members": [
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_type": "employee",
"volume": 50000
}
],
"line_of_coverage": "life",
"plan_name": "50k Employee Basic Life",
"signature_date": "2021-12-23"
}
],
"dependents": [
{
"custom_individual_id": "3f093cc0-4fef-4d5d-9267-ba5cdfc09827",
"id": "ab740704-7c37-4010-92b3-d22c6926be3e",
"person": {
"contact": {
"email_address": "jamie@testemail.com",
"email_address_type": "home",
"home_phone": "+12065551234"
},
"date_of_birth": "1990-01-02",
"first_name": "Jamie",
"home_address": {
"city": "San Francisco",
"county": "San Francisco",
"state": "CA",
"street_one": "1234 Home Ave",
"zip_code": "94107"
},
"last_name": "Johnson",
"mailing_address": {
"city": "San Francisco",
"state": "CA",
"street_one": "P.O. Box 1234",
"zip_code": "94107"
},
"marital_status": "married",
"sex": "F",
"ssn": "987654321"
},
"relationship": "spouse"
}
],
"employee": {
"classifications": {
"BranchName": "HQ",
"Department": "Sales"
},
"custom_individual_id": "bb6bfcd8-6657-4b77-8151-949ea8b5e44e",
"employment": {
"employment_dates": {
"full_time_start": "2015-01-01",
"hire_date": "2014-12-10"
},
"employment_status": "full-time",
"hours_worked": 50,
"occupation": "Senior Analyst",
"salary": {
"amount": 55000,
"effective_date": "2022-01-31",
"type": "salary",
"unit": "annual"
}
},
"group_id": "d0ec3837-3499-4a2f-8c58-966ef7e46d95",
"id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
"person": {
"contact": {
"email_address": "david@testemail.com",
"email_address_type": "home",
"home_phone": "+12065551234",
"preferred_method": "email",
"work_phone": "+12065559876"
},
"date_of_birth": "1985-06-22",
"first_name": "David",
"home_address": {
"city": "San Francisco",
"county": "San Francisco",
"state": "CA",
"street_one": "1234 Home Ave",
"zip_code": "94107"
},
"last_name": "Johnson",
"mailing_address": {
"city": "San Francisco",
"state": "CA",
"street_one": "P.O. Box 1234",
"zip_code": "94107"
},
"marital_status": "married",
"middle_name": "A",
"sex": "M",
"ssn": "123456789",
"suffix": "Jr"
}
}
}Path Parameters
The unique identifier of the employee
Query Parameters
Filter by associated status
Filter by ID (comma separated)
Filter by fulfillment summary carrier ID (comma separated)
Filter by fulfillment summary status (comma separated)
Response
Demographic information for the employee
Employment information for the employee
Employee employment dates
ISO-8601 date string for the hire date of the employee
ISO-8601 date string for start date as a full time employee with the group (if applicable)
ISO-8601 date string for the rehire date of the employee (if applicable)
ISO-8601 date string for the retirement date of the employee (if applicable)
ISO-8601 date string for the termination date of the employee (if applicable)
Employee employment status
full-time, part-time, contract, disabled, terminated, retired An integer of hours worked per week by the employee
Employee occupation or job title
Employee salary information
Amount of salary earned by the employee in US dollars and cents, as a decimal value
x > 0The ISO-8601 date-string the current employee salary is effective
Type of salary earned by the employee
hourly, salary Unit of salary earned by the employee
annual, month, semi-monthly, week, hour Personal information for the employee
ISO-8601 date string for the date of birth of the person
First name of the person
Home address of the person
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, 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, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Last name of the person
Mailing address of the person
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, 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, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Sex of the person
F, M, U, X Contact information for the person
Email address of the person
Type of email address
home, work Home phone number in E.164 format
Preferred written or spoken language of the person
Preferred method of contact for the person
mail, email, home-phone, work-phone, other True if the person can speak or communicate in English
Work phone number in E.164 format
Additional personal details of the person
American Indian status details (if applicable)
Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable
AL, AK, AZ, AR, CA, CO, CT, DE, DC, 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, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
Disability details (if applicable)
True if the person is in the military
True if the person is a student
Tobacco usage details (if applicable)
Duration of tobacco use
Frequency of tobacco use
List of types of tobacco use
pipe, cigarettes, chewing-tobacco True if the person uses tobacco of any kind
Maiden name of the person (deprecated)
Marital status of the person
single, married, domestic-partner, divorced, widowed, legally-separated Middle name of the person
Social Security Number of the person
Suffix of the person
Fields that classify employees for group structure mapping
Custom ID of the Employee from platform system. Required if member is new
1The unique ID of an event from the snapshot events list
1Group-level ID of the employee
1Unique ID of the Employee in Noyo's system. Leave blank if member is new
Mode describing how the contents of the snapshot will be processed
current_open List of coverage and enrollment decisions for each member
Noyo Carrier ID associated with this coverage
Employee and dependent members enrolling in this coverage
Effective end date of coverage for the member
Original effective start date of coverage for the member
Type of member enrolling in coverage
dependent, employee Platform ID of the employee or dependent from the snapshot
The unique ID of an event from the snapshot events list
1Unique ID of the employee or dependent from the snapshot
Effective date of the latest change related to this member coverage
Details about primary care providers
List of primary care providers
Code of the identification
Type of the identification code
service_provider_number, national_provider_identifier Code of the entity identifier
pcp, dental_pcp, obgyn Type of entity
person, non_person_entity First name of the primary care provider
Last name of the primary care provider
Middle name of the primary care provider
Organization name of the primary care provider.
Code which represents the relationship of the patient to the primary care provider
established, not_established, unknown The volume of coverage for the member (in dollars)
Line of coverage for the coverage
medical, dental, vision, life, add, std, ltd, accident, critical_illness, cancer, hospital_indemnity Details about enrolled member classifications at the carrier
Details about COBRA eligibility dates and enrollment status
Boolean representing whether or not a member is enrolled in COBRA
The date which represents when the individual is no longer eligible for COBRA
The date which represents when the individual is first eligible for COBRA
The date of the event which qualified the individual for COBRA
The reason of the event which qualified the individual for COBRA
termination_of_employment, reduction_of_work_hours, medicare, death, divorce, separation, ineligible_child, bankruptcy_of_retirees_former_employer, layoff, leave_of_absence The unique ID of the noyo plan associated with this coverage
Platform plan name that maps to a group plan in Noyo
1The date the decision for this coverage enrollment was made
List of demographic information for each dependent
Personal information for the dependent
ISO-8601 date string for the date of birth of the person
First name of the person
Home address of the person
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, 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, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Last name of the person
Mailing address of the person
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, 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, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Sex of the person
F, M, U, X Contact information for the person
Email address of the person
Type of email address
home, work Home phone number in E.164 format
Preferred written or spoken language of the person
Preferred method of contact for the person
mail, email, home-phone, work-phone, other True if the person can speak or communicate in English
Work phone number in E.164 format
Additional personal details of the person
American Indian status details (if applicable)
Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable
AL, AK, AZ, AR, CA, CO, CT, DE, DC, 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, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
Disability details (if applicable)
True if the person is in the military
True if the person is a student
Tobacco usage details (if applicable)
Duration of tobacco use
Frequency of tobacco use
List of types of tobacco use
pipe, cigarettes, chewing-tobacco True if the person uses tobacco of any kind
Maiden name of the person (deprecated)
Marital status of the person
single, married, domestic-partner, divorced, widowed, legally-separated Middle name of the person
Social Security Number of the person
Suffix of the person
Relationship of the dependent to the employee
spouse, child, domestic-partner, grandchild, civil-union, step-child, foster-child, adopted-child, legal-guardianship, ex-spouse, other Custom ID of the Dependent from platform system. Required if member is new
1The unique ID of an event from the snapshot events list
1Unique ID of the Dependent in Noyo's system. Leave blank if member is new
Boolean flag for autolinking workflow
List of events associated with member and coverage updates
The date the event occurred
Unique ID for the event, used internally in this payload
1The cause or real world scenario described in the event
adoption, benefit_class_change, change_to_part_time, change_to_full_time, cobra_enrollment, cobra_termination, cobra_update_other, court_order, death, demographic_change, dependent_open_enrollment, disability_status_change, divorce, eligibility_change, foster_care, immigration_status_change, leave_status_change, legal_guardian, lost_coverage, marriage, medicare, moved, newborn, new_hire, offline_change, open_enrollment, rate_changed, rehire, reinstatement, retirement, termination The type or category of member change made due to this event
coverage, demographic Configuration for handling omitted coverages
List of Individual Enrollment actions
A custom effective end date that will be used for the termination of the omitted coverage(s).
How Noyo will process the member snapshot's omitted coverage(s).
continue, reject, terminate The rule that Noyo should use to determine the explicit date of termination for the omitted coverage(s).
custom, end_of_current_month, end_of_prior_month Was this page helpful?
curl --request GET \
--url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_snapshot{
"coverages": [
{
"carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
"enrolled_members": [
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
"individual_type": "employee",
"latest_change_effective_date": "2022-02-13"
},
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
"individual_type": "dependent"
}
],
"line_of_coverage": "medical",
"plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9",
"signature_date": "2021-12-23"
},
{
"carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
"enrolled_members": [
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_type": "employee"
},
{
"effective_end_date": "2021-12-31",
"effective_start_date": "2022-01-01",
"individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
"individual_type": "dependent"
}
],
"line_of_coverage": "dental",
"plan_name": "DHMO Smile Plus",
"signature_date": "2021-12-23"
},
{
"carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
"enrolled_members": [
{
"effective_end_date": "9999-12-31",
"effective_start_date": "2022-01-01",
"individual_type": "employee",
"volume": 50000
}
],
"line_of_coverage": "life",
"plan_name": "50k Employee Basic Life",
"signature_date": "2021-12-23"
}
],
"dependents": [
{
"custom_individual_id": "3f093cc0-4fef-4d5d-9267-ba5cdfc09827",
"id": "ab740704-7c37-4010-92b3-d22c6926be3e",
"person": {
"contact": {
"email_address": "jamie@testemail.com",
"email_address_type": "home",
"home_phone": "+12065551234"
},
"date_of_birth": "1990-01-02",
"first_name": "Jamie",
"home_address": {
"city": "San Francisco",
"county": "San Francisco",
"state": "CA",
"street_one": "1234 Home Ave",
"zip_code": "94107"
},
"last_name": "Johnson",
"mailing_address": {
"city": "San Francisco",
"state": "CA",
"street_one": "P.O. Box 1234",
"zip_code": "94107"
},
"marital_status": "married",
"sex": "F",
"ssn": "987654321"
},
"relationship": "spouse"
}
],
"employee": {
"classifications": {
"BranchName": "HQ",
"Department": "Sales"
},
"custom_individual_id": "bb6bfcd8-6657-4b77-8151-949ea8b5e44e",
"employment": {
"employment_dates": {
"full_time_start": "2015-01-01",
"hire_date": "2014-12-10"
},
"employment_status": "full-time",
"hours_worked": 50,
"occupation": "Senior Analyst",
"salary": {
"amount": 55000,
"effective_date": "2022-01-31",
"type": "salary",
"unit": "annual"
}
},
"group_id": "d0ec3837-3499-4a2f-8c58-966ef7e46d95",
"id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
"person": {
"contact": {
"email_address": "david@testemail.com",
"email_address_type": "home",
"home_phone": "+12065551234",
"preferred_method": "email",
"work_phone": "+12065559876"
},
"date_of_birth": "1985-06-22",
"first_name": "David",
"home_address": {
"city": "San Francisco",
"county": "San Francisco",
"state": "CA",
"street_one": "1234 Home Ave",
"zip_code": "94107"
},
"last_name": "Johnson",
"mailing_address": {
"city": "San Francisco",
"state": "CA",
"street_one": "P.O. Box 1234",
"zip_code": "94107"
},
"marital_status": "married",
"middle_name": "A",
"sex": "M",
"ssn": "123456789",
"suffix": "Jr"
}
}
}