Create Member Snapshot

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id

string<uuid>

required

The unique identifier of the group for the employee referenced in the snapshot

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Body

application/json

employee

object

required

Demographic information for the employee

Show child attributes

employee.employment

object

required

Employment information for the employee

Show child attributes

employee.employment.employment_dates

object

required

Employee employment dates

Show child attributes

employee.employment.employment_dates.hire_date

string<date>

required

ISO-8601 date string for the hire date of the employee

Example:

"2017-01-17"

employee.employment.employment_dates.full_time_start

string

ISO-8601 date string for start date as a full time employee with the group (if applicable)

Example:

"2017-01-17"

employee.employment.employment_dates.rehire

string

ISO-8601 date string for the rehire date of the employee (if applicable)

Example:

"2018-02-01"

employee.employment.employment_dates.retirement

string

ISO-8601 date string for the retirement date of the employee (if applicable)

Example:

"2019-01-01"

employee.employment.employment_dates.terminated

string

ISO-8601 date string for the termination date of the employee (if applicable)

Example:

"2018-01-01"

employee.employment.employment_status

enum<string>

required

Employee employment status

Available options:

full-time,

part-time,

contract,

disabled,

terminated,

retired

employee.employment.hours_worked

integer<int32>

required

An integer of hours worked per week by the employee

Example:

40

employee.employment.occupation

string

Employee occupation or job title

Example:

"Engineer"

employee.employment.salary

object

Employee salary information

Show child attributes

employee.employment.salary.amount

number

Amount of salary earned by the employee in US dollars and cents, as a decimal value

Required range: x >= 0

Example:

52000

employee.employment.salary.effective_date

string

The ISO-8601 date-string the current employee salary is effective

Example:

"2022-02-01"

employee.employment.salary.type

enum<string>

Type of salary earned by the employee

Available options:

hourly,

salary

Example:

"salary"

employee.employment.salary.unit

enum<string>

Unit of salary earned by the employee

Available options:

annual,

month,

semi-monthly,

week,

hour

Example:

"annual"

employee.person

object

required

Personal information for the employee

Show child attributes

employee.person.date_of_birth

string<date>

required

ISO-8601 date string for the date of birth of the person

Example:

"1977-06-03"

employee.person.first_name

string

required

First name of the person

Example:

"Catherine"

employee.person.home_address

object

required

Home address of the person

Show child attributes

employee.person.home_address.city

string

required

City of the address

Example:

"Bend"

employee.person.home_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

employee.person.home_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

employee.person.home_address.zip_code

string

required

Zip code of the address

Example:

"97701"

employee.person.home_address.county

string

County of the address

Example:

"Deschutes"

employee.person.home_address.street_two

string

Line two of the address

Example:

"Apartment 5"

employee.person.last_name

string

required

Last name of the person

Example:

"Briggs"

employee.person.mailing_address

object

required

Mailing address of the person

Show child attributes

employee.person.mailing_address.city

string

required

City of the address

Example:

"Bend"

employee.person.mailing_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

employee.person.mailing_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

employee.person.mailing_address.zip_code

string

required

Zip code of the address

Example:

"97701"

employee.person.mailing_address.county

string

County of the address

Example:

"Deschutes"

employee.person.mailing_address.street_two

string

Line two of the address

Example:

"Apartment 5"

employee.person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

Example:

"F"

employee.person.contact

object

Contact information for the person

Show child attributes

employee.person.contact.email_address

string<email> | null

Email address of the person

Example:

"[email protected]"

employee.person.contact.email_address_type

enum<string>

Type of email address

Available options:

home,

work

Example:

"home"

employee.person.contact.home_phone

string

Home phone number in E.164 format

Example:

"+15555551212"

employee.person.contact.preferred_language

string

Preferred written or spoken language of the person

Example:

"English"

employee.person.contact.preferred_method

enum<string>

Preferred method of contact for the person

Available options:

mail,

email,

home-phone,

work-phone,

other

Example:

"email"

employee.person.contact.speaks_english

boolean

True if the person can speak or communicate in English

Example:

true

employee.person.contact.work_phone

string

Work phone number in E.164 format

Example:

"+15555551212"

employee.person.details

object

Additional personal details of the person

Show child attributes

employee.person.details.american_indian

object

American Indian status details (if applicable)

Show child attributes

employee.person.details.american_indian.state

enum<string>

Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable

Available options:

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

employee.person.details.american_indian.tribe

string

Name of the federally-recognized American Indian or Alaska Native tribe, if applicable

Example:

"Ojibwe"

employee.person.details.disability

object

Disability details (if applicable)

Show child attributes

employee.person.details.disability.communication

boolean

True if the disability impacts the ability to communicate or read

employee.person.details.disability.disabled

boolean

True if the member has a disability

employee.person.details.disability.reason

string

Description of the disability

employee.person.details.is_military

boolean

True if the person is in the military

employee.person.details.is_student

boolean

True if the person is a student

employee.person.details.tobacco

object

Tobacco usage details (if applicable)

Show child attributes

employee.person.details.tobacco.duration

string

Duration of tobacco use

Example:

"5 years"

employee.person.details.tobacco.frequency

string

Frequency of tobacco use

Example:

"Daily"

employee.person.details.tobacco.types

enum<string>[]

List of types of tobacco use

Minimum array length: 1

Available options:

pipe,

cigarettes,

chewing-tobacco

Example:

"cigarettes"

employee.person.details.tobacco.user

boolean

True if the person uses tobacco of any kind

Example:

true

employee.person.maiden_name

string

Maiden name of the person (deprecated)

employee.person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

Example:

"married"

employee.person.middle_name

string

Middle name of the person

Example:

"S"

employee.person.ssn

string | null

Social Security Number of the person

Example:

"123456789"

employee.person.suffix

string

Suffix of the person

employee.classifications

object

Fields that classify employees for group structure mapping

employee.custom_individual_id

string

Custom ID of the Employee from platform system. Required if member is new

Minimum string length: 1

employee.event_id

string

The unique ID of an event from the snapshot events list

Minimum string length: 1

Example:

"1"

employee.group_individual_id

string

Group-level ID of the employee

Minimum string length: 1

employee.id

string<uuid>

Unique ID of the Employee in Noyo's system. Leave blank if member is new

snapshot_mode

enum<string>

required

Mode describing how the contents of the snapshot will be processed

Available options:

current_open

Example:

"current_open"

coverages

object[]

List of coverage and enrollment decisions for each member

Show child attributes

coverages.carrier_id

string<uuid>

required

Noyo Carrier ID associated with this coverage

coverages.enrolled_members

object[]

required

Employee and dependent members enrolling in this coverage

Show child attributes

coverages.enrolled_members.effective_end_date

string<date>

required

Effective end date of coverage for the member. If the member is still enrolled in coverage, this should be set to 9999-12-31.

Example:

"9999-12-31"

coverages.enrolled_members.effective_start_date

string<date>

required

Original effective start date of coverage for the member

Example:

"2021-01-01"

coverages.enrolled_members.individual_type

enum<string>

required

Type of member enrolling in coverage

Available options:

dependent,

employee

Example:

"employee"

coverages.enrolled_members.custom_individual_id

string | null

Platform ID of the employee or dependent from the snapshot

coverages.enrolled_members.event_id

string

The unique ID of an event from the snapshot events list

Minimum string length: 1

Example:

"1"

coverages.enrolled_members.individual_id

string<uuid> | null

Unique ID of the employee or dependent from the snapshot

coverages.enrolled_members.latest_change_effective_date

string<date>

Effective date of the latest change related to this member coverage

Example:

"2022-01-01"

coverages.enrolled_members.pcp_details

object

Details about primary care providers

Show child attributes

coverages.enrolled_members.pcp_details.providers

object[]

required

List of primary care providers

Show child attributes

coverages.enrolled_members.pcp_details.providers.identification_code

string

required

Code of the identification

coverages.enrolled_members.pcp_details.providers.identification_code_type

enum<string>

required

Type of the identification code

Available options:

service_provider_number,

national_provider_identifier

coverages.enrolled_members.pcp_details.providers.entity_identifier_code

enum<string>

Code of the entity identifier

Available options:

pcp,

dental_pcp,

obgyn

coverages.enrolled_members.pcp_details.providers.entity_type

enum<string>

Type of entity

Available options:

person,

non_person_entity

coverages.enrolled_members.pcp_details.providers.first_name

string

First name of the primary care provider

coverages.enrolled_members.pcp_details.providers.last_name

string

Last name of the primary care provider

coverages.enrolled_members.pcp_details.providers.middle_name

string

Middle name of the primary care provider

coverages.enrolled_members.pcp_details.providers.organization_name

string

Organization name of the primary care provider.

coverages.enrolled_members.pcp_details.providers.patient_relationship_code

enum<string>

Code which represents the relationship of the patient to the primary care provider

Available options:

established,

not_established,

unknown

coverages.enrolled_members.volume

integer<int32>

The volume of coverage for the member (in dollars)

Example:

100

coverages.line_of_coverage

enum<string>

required

Line of coverage for the coverage

Available options:

medical,

dental,

vision,

life,

add,

std,

ltd,

accident,

critical_illness,

cancer,

health_fund,

hospital_indemnity,

pharmacy,

wellness

Example:

"dental"

coverages.carrier_config

object

Details about enrolled member classifications at the carrier

coverages.cobra_details

object

Details about COBRA eligibility dates and enrollment status

Show child attributes

coverages.cobra_details.cobra_enrolled

boolean

required

Boolean representing whether or not a member is enrolled in COBRA

coverages.cobra_details.eligibility_end_date

string<date>

required

The date which represents when the individual is no longer eligible for COBRA

coverages.cobra_details.eligibility_start_date

string<date>

required

The date which represents when the individual is first eligible for COBRA

coverages.cobra_details.qualifying_event_date

string<date>

The date of the event which qualified the individual for COBRA

coverages.cobra_details.qualifying_event_reason

enum<string>

The reason of the event which qualified the individual for COBRA

Available options:

termination_of_employment,

reduction_of_work_hours,

medicare,

death,

divorce,

separation,

ineligible_child,

bankruptcy_of_retirees_former_employer,

layoff,

leave_of_absence

coverages.custom_plan_id

string

Platform-specific plan ID. Even when custom_plan_id is provided, plan_id or plan_name must also be provided.

Minimum string length: 1

coverages.plan_id

string<uuid>

The unique ID of the noyo plan associated with this coverage. This field is required when plan_name is not provided.

coverages.plan_name

string

The name of this plan in your records or the name that maps to a group plan in Noyo. This field is required when plan_id is not provided.

Minimum string length: 1

coverages.signature_date

string<date>

The date the decision for this coverage enrollment was made

Example:

"2020-01-01"

dependents

object[]

List of demographic information for each dependent

Show child attributes

dependents.person

object

required

Personal information for the dependent

Show child attributes

dependents.person.date_of_birth

string<date>

required

ISO-8601 date string for the date of birth of the person

Example:

"1977-06-03"

dependents.person.first_name

string

required

First name of the person

Example:

"Catherine"

dependents.person.home_address

object

required

Home address of the person

Show child attributes

dependents.person.home_address.city

string

required

City of the address

Example:

"Bend"

dependents.person.home_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

dependents.person.home_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

dependents.person.home_address.zip_code

string

required

Zip code of the address

Example:

"97701"

dependents.person.home_address.county

string

County of the address

Example:

"Deschutes"

dependents.person.home_address.street_two

string

Line two of the address

Example:

"Apartment 5"

dependents.person.last_name

string

required

Last name of the person

Example:

"Briggs"

dependents.person.mailing_address

object

required

Mailing address of the person

Show child attributes

dependents.person.mailing_address.city

string

required

City of the address

Example:

"Bend"

dependents.person.mailing_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

dependents.person.mailing_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

dependents.person.mailing_address.zip_code

string

required

Zip code of the address

Example:

"97701"

dependents.person.mailing_address.county

string

County of the address

Example:

"Deschutes"

dependents.person.mailing_address.street_two

string

Line two of the address

Example:

"Apartment 5"

dependents.person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

Example:

"F"

dependents.person.contact

object

Contact information for the person

Show child attributes

dependents.person.contact.email_address

string<email> | null

Email address of the person

Example:

"[email protected]"

dependents.person.contact.email_address_type

enum<string>

Type of email address

Available options:

home,

work

Example:

"home"

dependents.person.contact.home_phone

string

Home phone number in E.164 format

Example:

"+15555551212"

dependents.person.contact.preferred_language

string

Preferred written or spoken language of the person

Example:

"English"

dependents.person.contact.preferred_method

enum<string>

Preferred method of contact for the person

Available options:

mail,

email,

home-phone,

work-phone,

other

Example:

"email"

dependents.person.contact.speaks_english

boolean

True if the person can speak or communicate in English

Example:

true

dependents.person.contact.work_phone

string

Work phone number in E.164 format

Example:

"+15555551212"

dependents.person.details

object

Additional personal details of the person

Show child attributes

dependents.person.details.american_indian

object

American Indian status details (if applicable)

Show child attributes

dependents.person.details.american_indian.state

enum<string>

Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable

Available options:

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

dependents.person.details.american_indian.tribe

string

Name of the federally-recognized American Indian or Alaska Native tribe, if applicable

Example:

"Ojibwe"

dependents.person.details.disability

object

Disability details (if applicable)

Show child attributes

dependents.person.details.disability.communication

boolean

True if the disability impacts the ability to communicate or read

dependents.person.details.disability.disabled

boolean

True if the member has a disability

dependents.person.details.disability.reason

string

Description of the disability

dependents.person.details.is_military

boolean

True if the person is in the military

dependents.person.details.is_student

boolean

True if the person is a student

dependents.person.details.tobacco

object

Tobacco usage details (if applicable)

Show child attributes

dependents.person.details.tobacco.duration

string

Duration of tobacco use

Example:

"5 years"

dependents.person.details.tobacco.frequency

string

Frequency of tobacco use

Example:

"Daily"

dependents.person.details.tobacco.types

enum<string>[]

List of types of tobacco use

Minimum array length: 1

Available options:

pipe,

cigarettes,

chewing-tobacco

Example:

"cigarettes"

dependents.person.details.tobacco.user

boolean

True if the person uses tobacco of any kind

Example:

true

dependents.person.maiden_name

string

Maiden name of the person (deprecated)

dependents.person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

Example:

"married"

dependents.person.middle_name

string

Middle name of the person

Example:

"S"

dependents.person.ssn

string | null

Social Security Number of the person

Example:

"123456789"

dependents.person.suffix

string

Suffix of the person

dependents.relationship

enum<string>

required

Relationship of the dependent to the employee

Available options:

spouse,

child,

domestic-partner,

grandchild,

civil-union,

step-child,

foster-child,

adopted-child,

legal-guardianship,

ex-spouse,

other

dependents.custom_individual_id

string

Custom ID of the Dependent from platform system. Required if member is new

Minimum string length: 1

dependents.event_id

string

The unique ID of an event from the snapshot events list

Minimum string length: 1

Example:

"1"

dependents.group_individual_id

string

Group-level ID of the dependent

Minimum string length: 1

dependents.id

string<uuid>

Unique ID of the Dependent in Noyo's system. Leave blank if member is new

enable_member_auto_link

boolean

default:false

Boolean flag for autolinking workflow

events

object[]

List of events associated with member and coverage updates

Show child attributes

events.date

string<date>

required

The date the event occurred

events.id

string

required

Unique ID for the event, used internally in this payload

Minimum string length: 1

events.reason

enum<string>

required

The cause or real world scenario described in the event

Available options:

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

events.type

enum<string>

required

The type or category of member change made due to this event

Available options:

coverage,

demographic

omitted_coverage_handling

object

Configuration for handling omitted coverages

Show child attributes

omitted_coverage_handling.custom

object

List of Individual Enrollment actions

Show child attributes

omitted_coverage_handling.custom.effective_end_date

string<date>

A custom effective end date that will be used for the termination of the omitted coverage(s).

Example:

"2024-03-15"

omitted_coverage_handling.policy

enum<string>

default:reject

How Noyo will process the member snapshot's omitted coverage(s).

Available options:

continue,

reject,

terminate

Example:

"terminate"

omitted_coverage_handling.termination_rule

enum<string>

The rule that Noyo should use to determine the explicit date of termination for the omitted coverage(s).

Available options:

custom,

end_of_current_month,

end_of_prior_month

Example:

"end_of_current_month"

Response

Successful Response - Returns the contents of the newly created Member Snapshot

created

integer

required

The date the record was created

created_members

object[]

required

List of created members

Show child attributes

created_members.id

string<uuid>

required

Unique ID of the Member in Noyo's system.

created_members.type

string

required

Type of the Member. Either 'employee' or 'dependent.

created_members.custom_individual_id

string

Custom ID of the Member from the platform's system.

employee_id

string<uuid>

required

Unique ID of the employee in Noyo

string<uuid>

required

Unique identifier of the record in Noyo

member_snapshot

object

required

Member snapshot post Noyo processing (e.g. adding omitted coverages, applying rulesets, etc.)

Show child attributes

member_snapshot.employee

object

required

Demographic information for the employee

Show child attributes

member_snapshot.employee.employment

object

required

Employment information for the employee

Show child attributes

member_snapshot.employee.employment.employment_dates

object

required

Employee employment dates

Show child attributes

member_snapshot.employee.employment.employment_dates.hire_date

string<date>

required

ISO-8601 date string for the hire date of the employee

Example:

"2017-01-17"

member_snapshot.employee.employment.employment_dates.full_time_start

string

ISO-8601 date string for start date as a full time employee with the group (if applicable)

Example:

"2017-01-17"

member_snapshot.employee.employment.employment_dates.rehire

string

ISO-8601 date string for the rehire date of the employee (if applicable)

Example:

"2018-02-01"

member_snapshot.employee.employment.employment_dates.retirement

string

ISO-8601 date string for the retirement date of the employee (if applicable)

Example:

"2019-01-01"

member_snapshot.employee.employment.employment_dates.terminated

string

ISO-8601 date string for the termination date of the employee (if applicable)

Example:

"2018-01-01"

member_snapshot.employee.employment.employment_status

enum<string>

required

Employee employment status

Available options:

full-time,

part-time,

contract,

disabled,

terminated,

retired

member_snapshot.employee.employment.hours_worked

integer<int32>

required

An integer of hours worked per week by the employee

Example:

40

member_snapshot.employee.employment.occupation

string

Employee occupation or job title

Example:

"Engineer"

member_snapshot.employee.employment.salary

object

Employee salary information

Show child attributes

member_snapshot.employee.employment.salary.amount

number

Amount of salary earned by the employee in US dollars and cents, as a decimal value

Required range: x >= 0

Example:

52000

member_snapshot.employee.employment.salary.effective_date

string

The ISO-8601 date-string the current employee salary is effective

Example:

"2022-02-01"

member_snapshot.employee.employment.salary.type

enum<string>

Type of salary earned by the employee

Available options:

hourly,

salary

Example:

"salary"

member_snapshot.employee.employment.salary.unit

enum<string>

Unit of salary earned by the employee

Available options:

annual,

month,

semi-monthly,

week,

hour

Example:

"annual"

member_snapshot.employee.person

object

required

Personal information for the employee

Show child attributes

member_snapshot.employee.person.date_of_birth

string<date>

required

ISO-8601 date string for the date of birth of the person

Example:

"1977-06-03"

member_snapshot.employee.person.first_name

string

required

First name of the person

Example:

"Catherine"

member_snapshot.employee.person.home_address

object

required

Home address of the person

Show child attributes

member_snapshot.employee.person.home_address.city

string

required

City of the address

Example:

"Bend"

member_snapshot.employee.person.home_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

member_snapshot.employee.person.home_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

member_snapshot.employee.person.home_address.zip_code

string

required

Zip code of the address

Example:

"97701"

member_snapshot.employee.person.home_address.county

string

County of the address

Example:

"Deschutes"

member_snapshot.employee.person.home_address.street_two

string

Line two of the address

Example:

"Apartment 5"

member_snapshot.employee.person.last_name

string

required

Last name of the person

Example:

"Briggs"

member_snapshot.employee.person.mailing_address

object

required

Mailing address of the person

Show child attributes

member_snapshot.employee.person.mailing_address.city

string

required

City of the address

Example:

"Bend"

member_snapshot.employee.person.mailing_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

member_snapshot.employee.person.mailing_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

member_snapshot.employee.person.mailing_address.zip_code

string

required

Zip code of the address

Example:

"97701"

member_snapshot.employee.person.mailing_address.county

string

County of the address

Example:

"Deschutes"

member_snapshot.employee.person.mailing_address.street_two

string

Line two of the address

Example:

"Apartment 5"

member_snapshot.employee.person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

Example:

"F"

member_snapshot.employee.person.contact

object

Contact information for the person

Show child attributes

member_snapshot.employee.person.contact.email_address

string<email> | null

Email address of the person

Example:

"[email protected]"

member_snapshot.employee.person.contact.email_address_type

enum<string>

Type of email address

Available options:

home,

work

Example:

"home"

member_snapshot.employee.person.contact.home_phone

string

Home phone number in E.164 format

Example:

"+15555551212"

member_snapshot.employee.person.contact.preferred_language

string

Preferred written or spoken language of the person

Example:

"English"

member_snapshot.employee.person.contact.preferred_method

enum<string>

Preferred method of contact for the person

Available options:

mail,

email,

home-phone,

work-phone,

other

Example:

"email"

member_snapshot.employee.person.contact.speaks_english

boolean

True if the person can speak or communicate in English

Example:

true

member_snapshot.employee.person.contact.work_phone

string

Work phone number in E.164 format

Example:

"+15555551212"

member_snapshot.employee.person.details

object

Additional personal details of the person

Show child attributes

member_snapshot.employee.person.details.american_indian

object

American Indian status details (if applicable)

Show child attributes

member_snapshot.employee.person.details.american_indian.state

enum<string>

Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable

Available options:

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

member_snapshot.employee.person.details.american_indian.tribe

string

Name of the federally-recognized American Indian or Alaska Native tribe, if applicable

Example:

"Ojibwe"

member_snapshot.employee.person.details.disability

object

Disability details (if applicable)

Show child attributes

member_snapshot.employee.person.details.disability.communication

boolean

True if the disability impacts the ability to communicate or read

member_snapshot.employee.person.details.disability.disabled

boolean

True if the member has a disability

member_snapshot.employee.person.details.disability.reason

string

Description of the disability

member_snapshot.employee.person.details.is_military

boolean

True if the person is in the military

member_snapshot.employee.person.details.is_student

boolean

True if the person is a student

member_snapshot.employee.person.details.tobacco

object

Tobacco usage details (if applicable)

Show child attributes

member_snapshot.employee.person.details.tobacco.duration

string

Duration of tobacco use

Example:

"5 years"

member_snapshot.employee.person.details.tobacco.frequency

string

Frequency of tobacco use

Example:

"Daily"

member_snapshot.employee.person.details.tobacco.types

enum<string>[]

List of types of tobacco use

Minimum array length: 1

Available options:

pipe,

cigarettes,

chewing-tobacco

Example:

"cigarettes"

member_snapshot.employee.person.details.tobacco.user

boolean

True if the person uses tobacco of any kind

Example:

true

member_snapshot.employee.person.maiden_name

string

Maiden name of the person (deprecated)

member_snapshot.employee.person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

Example:

"married"

member_snapshot.employee.person.middle_name

string

Middle name of the person

Example:

"S"

member_snapshot.employee.person.ssn

string | null

Social Security Number of the person

Example:

"123456789"

member_snapshot.employee.person.suffix

string

Suffix of the person

member_snapshot.employee.classifications

object

Fields that classify employees for group structure mapping

member_snapshot.employee.custom_individual_id

string

Custom ID of the Employee from platform system. Required if member is new

Minimum string length: 1

member_snapshot.employee.event_id

string

The unique ID of an event from the snapshot events list

Minimum string length: 1

Example:

"1"

member_snapshot.employee.group_individual_id

string

Group-level ID of the employee

Minimum string length: 1

member_snapshot.employee.id

string<uuid>

Unique ID of the Employee in Noyo's system. Leave blank if member is new

member_snapshot.snapshot_mode

enum<string>

required

Mode describing how the contents of the snapshot will be processed

Available options:

current_open

Example:

"current_open"

member_snapshot.coverages

object[]

List of coverage and enrollment decisions for each member

Show child attributes

member_snapshot.coverages.carrier_id

string<uuid>

required

Noyo Carrier ID associated with this coverage

member_snapshot.coverages.enrolled_members

object[]

required

Employee and dependent members enrolling in this coverage

Show child attributes

member_snapshot.coverages.enrolled_members.effective_end_date

string<date>

required

Effective end date of coverage for the member. If the member is still enrolled in coverage, this should be set to 9999-12-31.

Example:

"9999-12-31"

member_snapshot.coverages.enrolled_members.effective_start_date

string<date>

required

Original effective start date of coverage for the member

Example:

"2021-01-01"

member_snapshot.coverages.enrolled_members.individual_type

enum<string>

required

Type of member enrolling in coverage

Available options:

dependent,

employee

Example:

"employee"

member_snapshot.coverages.enrolled_members.custom_individual_id

string | null

Platform ID of the employee or dependent from the snapshot

member_snapshot.coverages.enrolled_members.event_id

string

The unique ID of an event from the snapshot events list

Minimum string length: 1

Example:

"1"

member_snapshot.coverages.enrolled_members.individual_id

string<uuid> | null

Unique ID of the employee or dependent from the snapshot

member_snapshot.coverages.enrolled_members.latest_change_effective_date

string<date>

Effective date of the latest change related to this member coverage

Example:

"2022-01-01"

member_snapshot.coverages.enrolled_members.pcp_details

object

Details about primary care providers

Show child attributes

member_snapshot.coverages.enrolled_members.pcp_details.providers

object[]

required

List of primary care providers

Show child attributes

member_snapshot.coverages.enrolled_members.pcp_details.providers.identification_code

string

required

Code of the identification

member_snapshot.coverages.enrolled_members.pcp_details.providers.identification_code_type

enum<string>

required

Type of the identification code

Available options:

service_provider_number,

national_provider_identifier

member_snapshot.coverages.enrolled_members.pcp_details.providers.entity_identifier_code

enum<string>

Code of the entity identifier

Available options:

pcp,

dental_pcp,

obgyn

member_snapshot.coverages.enrolled_members.pcp_details.providers.entity_type

enum<string>

Type of entity

Available options:

person,

non_person_entity

member_snapshot.coverages.enrolled_members.pcp_details.providers.first_name

string

First name of the primary care provider

member_snapshot.coverages.enrolled_members.pcp_details.providers.last_name

string

Last name of the primary care provider

member_snapshot.coverages.enrolled_members.pcp_details.providers.middle_name

string

Middle name of the primary care provider

member_snapshot.coverages.enrolled_members.pcp_details.providers.organization_name

string

Organization name of the primary care provider.

member_snapshot.coverages.enrolled_members.pcp_details.providers.patient_relationship_code

enum<string>

Code which represents the relationship of the patient to the primary care provider

Available options:

established,

not_established,

unknown

member_snapshot.coverages.enrolled_members.volume

integer<int32>

The volume of coverage for the member (in dollars)

Example:

100

member_snapshot.coverages.line_of_coverage

enum<string>

required

Line of coverage for the coverage

Available options:

medical,

dental,

vision,

life,

add,

std,

ltd,

accident,

critical_illness,

cancer,

health_fund,

hospital_indemnity,

pharmacy,

wellness

Example:

"dental"

member_snapshot.coverages.carrier_config

object

Details about enrolled member classifications at the carrier

member_snapshot.coverages.cobra_details

object

Details about COBRA eligibility dates and enrollment status

Show child attributes

member_snapshot.coverages.cobra_details.cobra_enrolled

boolean

required

Boolean representing whether or not a member is enrolled in COBRA

member_snapshot.coverages.cobra_details.eligibility_end_date

string<date>

required

The date which represents when the individual is no longer eligible for COBRA

member_snapshot.coverages.cobra_details.eligibility_start_date

string<date>

required

The date which represents when the individual is first eligible for COBRA

member_snapshot.coverages.cobra_details.qualifying_event_date

string<date>

The date of the event which qualified the individual for COBRA

member_snapshot.coverages.cobra_details.qualifying_event_reason

enum<string>

The reason of the event which qualified the individual for COBRA

Available options:

termination_of_employment,

reduction_of_work_hours,

medicare,

death,

divorce,

separation,

ineligible_child,

bankruptcy_of_retirees_former_employer,

layoff,

leave_of_absence

member_snapshot.coverages.custom_plan_id

string

Platform-specific plan ID. Even when custom_plan_id is provided, plan_id or plan_name must also be provided.

Minimum string length: 1

member_snapshot.coverages.plan_id

string<uuid>

The unique ID of the noyo plan associated with this coverage. This field is required when plan_name is not provided.

member_snapshot.coverages.plan_name

string

The name of this plan in your records or the name that maps to a group plan in Noyo. This field is required when plan_id is not provided.

Minimum string length: 1

member_snapshot.coverages.signature_date

string<date>

The date the decision for this coverage enrollment was made

Example:

"2020-01-01"

member_snapshot.dependents

object[]

List of demographic information for each dependent

Show child attributes

member_snapshot.dependents.person

object

required

Personal information for the dependent

Show child attributes

member_snapshot.dependents.person.date_of_birth

string<date>

required

ISO-8601 date string for the date of birth of the person

Example:

"1977-06-03"

member_snapshot.dependents.person.first_name

string

required

First name of the person

Example:

"Catherine"

member_snapshot.dependents.person.home_address

object

required

Home address of the person

Show child attributes

member_snapshot.dependents.person.home_address.city

string

required

City of the address

Example:

"Bend"

member_snapshot.dependents.person.home_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

member_snapshot.dependents.person.home_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

member_snapshot.dependents.person.home_address.zip_code

string

required

Zip code of the address

Example:

"97701"

member_snapshot.dependents.person.home_address.county

string

County of the address

Example:

"Deschutes"

member_snapshot.dependents.person.home_address.street_two

string

Line two of the address

Example:

"Apartment 5"

member_snapshot.dependents.person.last_name

string

required

Last name of the person

Example:

"Briggs"

member_snapshot.dependents.person.mailing_address

object

required

Mailing address of the person

Show child attributes

member_snapshot.dependents.person.mailing_address.city

string

required

City of the address

Example:

"Bend"

member_snapshot.dependents.person.mailing_address.state

enum<string>

required

State postal code of the address

Available options:

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

Example:

"OR"

member_snapshot.dependents.person.mailing_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

member_snapshot.dependents.person.mailing_address.zip_code

string

required

Zip code of the address

Example:

"97701"

member_snapshot.dependents.person.mailing_address.county

string

County of the address

Example:

"Deschutes"

member_snapshot.dependents.person.mailing_address.street_two

string

Line two of the address

Example:

"Apartment 5"

member_snapshot.dependents.person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

Example:

"F"

member_snapshot.dependents.person.contact

object

Contact information for the person

Show child attributes

member_snapshot.dependents.person.contact.email_address

string<email> | null

Email address of the person

Example:

"[email protected]"

member_snapshot.dependents.person.contact.email_address_type

enum<string>

Type of email address

Available options:

home,

work

Example:

"home"

member_snapshot.dependents.person.contact.home_phone

string

Home phone number in E.164 format

Example:

"+15555551212"

member_snapshot.dependents.person.contact.preferred_language

string

Preferred written or spoken language of the person

Example:

"English"

member_snapshot.dependents.person.contact.preferred_method

enum<string>

Preferred method of contact for the person

Available options:

mail,

email,

home-phone,

work-phone,

other

Example:

"email"

member_snapshot.dependents.person.contact.speaks_english

boolean

True if the person can speak or communicate in English

Example:

true

member_snapshot.dependents.person.contact.work_phone

string

Work phone number in E.164 format

Example:

"+15555551212"

member_snapshot.dependents.person.details

object

Additional personal details of the person

Show child attributes

member_snapshot.dependents.person.details.american_indian

object

American Indian status details (if applicable)

Show child attributes

member_snapshot.dependents.person.details.american_indian.state

enum<string>

Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable

Available options:

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

member_snapshot.dependents.person.details.american_indian.tribe

string

Name of the federally-recognized American Indian or Alaska Native tribe, if applicable

Example:

"Ojibwe"

member_snapshot.dependents.person.details.disability

object

Disability details (if applicable)

Show child attributes

member_snapshot.dependents.person.details.disability.communication

boolean

True if the disability impacts the ability to communicate or read

member_snapshot.dependents.person.details.disability.disabled

boolean

True if the member has a disability

member_snapshot.dependents.person.details.disability.reason

string

Description of the disability

member_snapshot.dependents.person.details.is_military

boolean

True if the person is in the military

member_snapshot.dependents.person.details.is_student

boolean

True if the person is a student

member_snapshot.dependents.person.details.tobacco

object

Tobacco usage details (if applicable)

Show child attributes

member_snapshot.dependents.person.details.tobacco.duration

string

Duration of tobacco use

Example:

"5 years"

member_snapshot.dependents.person.details.tobacco.frequency

string

Frequency of tobacco use

Example:

"Daily"

member_snapshot.dependents.person.details.tobacco.types

enum<string>[]

List of types of tobacco use

Minimum array length: 1

Available options:

pipe,

cigarettes,

chewing-tobacco

Example:

"cigarettes"

member_snapshot.dependents.person.details.tobacco.user

boolean

True if the person uses tobacco of any kind

Example:

true

member_snapshot.dependents.person.maiden_name

string

Maiden name of the person (deprecated)

member_snapshot.dependents.person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

Example:

"married"

member_snapshot.dependents.person.middle_name

string

Middle name of the person

Example:

"S"

member_snapshot.dependents.person.ssn

string | null

Social Security Number of the person

Example:

"123456789"

member_snapshot.dependents.person.suffix

string

Suffix of the person

member_snapshot.dependents.relationship

enum<string>

required

Relationship of the dependent to the employee

Available options:

spouse,

child,

domestic-partner,

grandchild,

civil-union,

step-child,

foster-child,

adopted-child,

legal-guardianship,

ex-spouse,

other

member_snapshot.dependents.custom_individual_id

string

Custom ID of the Dependent from platform system. Required if member is new

Minimum string length: 1

member_snapshot.dependents.event_id

string

The unique ID of an event from the snapshot events list

Minimum string length: 1

Example:

"1"

member_snapshot.dependents.group_individual_id

string

Group-level ID of the dependent

Minimum string length: 1

member_snapshot.dependents.id

string<uuid>

Unique ID of the Dependent in Noyo's system. Leave blank if member is new

member_snapshot.enable_member_auto_link

boolean

default:false

Boolean flag for autolinking workflow

member_snapshot.events

object[]

List of events associated with member and coverage updates

Show child attributes

member_snapshot.events.date

string<date>

required

The date the event occurred

member_snapshot.events.id

string

required

Unique ID for the event, used internally in this payload

Minimum string length: 1

member_snapshot.events.reason

enum<string>

required

The cause or real world scenario described in the event

Available options:

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

member_snapshot.events.type

enum<string>

required

The type or category of member change made due to this event

Available options:

coverage,

demographic

member_snapshot.omitted_coverage_handling

object

Configuration for handling omitted coverages

Show child attributes

member_snapshot.omitted_coverage_handling.custom

object

List of Individual Enrollment actions

Show child attributes

member_snapshot.omitted_coverage_handling.custom.effective_end_date

string<date>

A custom effective end date that will be used for the termination of the omitted coverage(s).

Example:

"2024-03-15"

member_snapshot.omitted_coverage_handling.policy

enum<string>

default:reject

How Noyo will process the member snapshot's omitted coverage(s).

Available options:

continue,

reject,

terminate

Example:

"terminate"

member_snapshot.omitted_coverage_handling.termination_rule

enum<string>

The rule that Noyo should use to determine the explicit date of termination for the omitted coverage(s).

Available options:

custom,

end_of_current_month,

end_of_prior_month

Example:

"end_of_current_month"

modified

integer

required

The date the record was last updated

status

enum<string>

required

Status of the member snapshot

Available options:

processing,

completed,

replaced,

canceled,

submitted

version

string<uuid>

required

Current version of the record

warnings

string[]

required

Warnings generated during processing of the member snapshot

fulfillment_summary

object[]

List of member snapshot fulfillment statuses per carrier

Show child attributes

fulfillment_summary.carrier_id

string<uuid>

required

Unique identifier of the Carrier in Noyo

fulfillment_summary.status

enum<string>

required

Status of the member snapshot fulfillment at carrier

Available options:

invalid,

no_changes,

processing,

replaced,

scheduled,

sent,

valid,

not_connected

fulfillment_summary.errors

string[]

Errors generated while processing the member snapshot at the carrier

inbound_snapshot

string

Exact member snapshot as received by Noyo and prior to any processing (e.g. adding omitted coverages, applying rulesets, etc.)

replaced_by

string<uuid>

UUID of the member snapshot that replaced the returned snapshot

Groups

Members

Changes

Legacy

Create Member Snapshot

Authorizations

Path Parameters

Body

Response