Group and Plan Data

Data available for groups, enrollments, and plans

Group Data

The group object represents an insured group/employer that is managed by your organization and successfully connected to Noyo. Group, plan, and enrollment data is available when a group connection request for a Sync carrier is complete or when a Send group connection's status is action_required.

In general, you cannot edit group-level data through Noyo, with the exception of name, FEIN, DBA name, and SIC code. All other group level data, like location addresses or tax information, must be changed directly with the carrier.

Group basics

Get a Single Group to view details such as the name of the group, the EIN, and the SIC code of the company. To see all the groups managed with Noyo by your organization, you can Get a List of All Groups. You can search that groups list with the company query param. It allows searches based on the group's name or dba_name values.

Other helpful group data is available using the group's ID:

Carrier configurations

Certain carriers have custom data for each group, such as billing information. Use the Get Group Carrier Configurations endpoint to retrieve any carrier-specific configuration data for a given group. This endpoint can be used to retrieve carrier-specific configuration data.

Here are the options for this object:

ObjectTypeDescription
group_iduuidUnique identifier of the group in Noyo
carrier_iduuidUnique identifier of the carrier in Noyo
carrier_group_idstringUnique identifier for the group in the carrier system
configurationobjectCarrier configuration details for the group

Filter for a carrier's group ID

You can use the combination of a carrier_id and a carrier_group_id to filter for a carrier-specific group ID. This ID will depend on the carrier, but it will generally be a unique identifier for the group from the carrier's system.

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups?carrier_id=3092866a-e3a7-4c6e-964c-2bc45dfe7ad0&carrier_group_id=OXNEMWQ4WkxoQ0oK

Carrier syncs

Noyo regularly syncs–or retrieves–group data from any Sync carriers the group has coverage with to bring in the carrier's version of the group. The Get Latest Audit endpoint returns metadata about the last group audit that was completed.

If no group audits have been completed, the completed_at timestamp will be the timestamp of when the group was created and the carrier_ids array will be empty.

Plan and enrollment data

Enrollments

The enrollments object represents the each individual line of coverage (LOC) being offered by a specific group (e.g. medical, dental, vision). You can manage the following types of benefits through Noyo:

  • Accident
  • Accidental death and dismemberment (AD&D)
  • Cancer
  • Critical Illness
  • Dental
  • Hospital indemnity
  • Life
  • Long-term disability (LTD)
  • Medical
  • Short-term disability (STD)
  • Vision

Start by getting a list of all enrollments for a given group. This will return IDs, dates, and statuses for all the group's enrollments. You can then use each enrollment ID to get a single group enrollment and its associated data in the future.

Plan data

The plans object represents a plan or benefit offered by a carrier to employee or dependent members of a group.

You can use the group's ID to get a list of all their plans, which returns IDs for each individual plan. You can also use a group plan ID to get details on a specific plan.

Note that the response will be nested in a plan attribute. Different data is included in the response for each plan depending on its LOC. See below for specific data returned across all LOCs supported by Noyo and more detail on waiting periods.

Accident Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group accident plan
name*stringName of the group accident plan
codestringPlan code of the group accident plan
plan_type*stringType of group accident plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group accident plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group accident plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group accident plan
termination_policy*stringTermination policy for the group accident plan. One of: end_of_month, fifteenth_of_month, last_work_date
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

AD&D Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group AD&D plan
name*stringName of the group AD&D plan
codestringPlan code of the group AD&D plan
plan_type*stringType of group AD&D plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group AD&D plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group AD&D plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group AD&D plan
termination_policy*stringTermination policy for the group AD&D plan. One of: end_of_month, fifteenth_of_month, last_work_date
volume_rules*objectVolume rules for the group AD&D plan
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Cancer Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group cancer plan
name*stringName of the group cancer plan
codestringPlan code of the group cancer plan
plan_type*stringType of group cancer plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group cancer plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group cancer plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group cancer plan
termination_policy*stringTermination policy for the group cancer plan. One of: end_of_month, fifteenth_of_month, last_work_date
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Critical Illness Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group critical illness plan
name*stringName of the group critical illness plan
codestringPlan code of the group critical illness plan
plan_type*stringType of group critical illness plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group critical illness plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group critical illness plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group critical illness plan
termination_policy*stringTermination policy for the group critical illness plan. One of: end_of_month, fifteenth_of_month, last_work_date
volume_rules*objectVolume rules for the group critical illness plan
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Dental Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group dental plan
name*stringName of the group dental plan
codestringPlan code of the group dental plan
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
plan_typestringType of group dental plan. One of: aso, dhmo, epo, indemnity, pos, ppo
networkstringNetwork name of the plan designated by the carrier
voluntarybooleanTrue if the group dental plan is a voluntary plan
status*stringStatus of the group dental plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group dental plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group dental plan
termination_policy*stringTermination policy for the group dental plan. One of: end_of_month, fifteenth_of_month, last_work_date
cobra_rules*objecteligible: True if group plan is eligible for COBRA enrollments
created*timestampThe date the record was created
modified*timestampThe date the record was last updated
plan_configuration*objectGroup plan configuration details

Hospital Indemnity Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group hospital indemnity plan
name*stringName of the group hospital indemnity plan
codestringPlan code of the group hospital indemnity plan
plan_type*stringType of group hospital indemnity plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group hospital indemnity plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group hospital indemnity plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group hospital indemnity plan
termination_policy*stringTermination policy for the group hospital indemnity plan. One of: end_of_month, fifteenth_of_month, last_work_date
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Life Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group life plan
name*stringName of the group life plan
codestringPlan code of the group life plan
plan_type*stringType of group life plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group life plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group life plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group life plan
termination_policy*stringTermination policy for the group life plan. One of: end_of_month, fifteenth_of_month, last_work_date
volume_rules*objectVolume rules for the group life plan
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

LTD Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group LTD plan
name*stringName of the group LTD plan
codestringPlan code of the group LTD plan
plan_type*stringType of group LTD plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group LTD plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group LTD plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group LTD plan
termination_policy*stringTermination policy for the group LTD plan. One of: end_of_month, fifteenth_of_month, last_work_date
volume_rules*objectVolume rules for the group LTD plan
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Medical Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group medical plan
name*stringName of the group medical plan
codestringPlan code of the group medical plan
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
plan_typestringType of group medical plan. One of: epo, hdhp, hmo, hmp, pos, ppo
networkstringNetwork name of the plan designated by the carrier
metal_tierstringMetal tier designation of the group medical plan. One of: bronze, gold, platinum, silver
status*stringStatus of the group medical plan. One of: active, discontinued, pending
eligible_member_typesarrayEligible member types for the group medical plan
waiting_periods*arrayMember waiting period details for the group medical plan
termination_policy*stringTermination policy for the group medical plan. One of: end_of_month, fifteenth_of_month, last_work_date
cobra_rules*objecteligible: True if group plan is eligible for COBRA enrollments
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

STD Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group STD plan
name*stringName of the group STD plan
codestringPlan code of the group STD plan
plan_type*stringType of group STD plan. One of: basic, voluntary
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
status*stringStatus of the group STD plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group STD plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group STD plan
termination_policy*stringTermination policy for the group STD plan. One of: end_of_month, fifteenth_of_month, last_work_date
volume_rules*objectVolume rules for the group STD plan
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Vision Plan Object

ObjectTypeDescription
id*uuidUnique identifier of the record in Noyo
version*uuidCurrent version of the record
group_enrollment_id*uuidUnique identifier of the associated group enrollment in the Noyo system
carrier_id*uuidUnique identifier of the associated carrier in Noyo
line_of_coverage*stringLine of coverage for the group vision plan
name*stringName of the group vision plan
codestringPlan code of the group vision plan
effective_start_datedateISO-8601 date string for the effective start date of the record
effective_end_datedateISO-8601 date string for the effective end date of the record
voluntarybooleanTrue if the group vision plan is a voluntary plan
status*stringStatus of the group vision plan. One of: active, discontinued, pending
eligible_member_types*arrayList of member types eligible for the group vision plan. One of: all, child, domestic-partner, employee, spouse
waiting_periods*arrayMember waiting period details for the group vision plan
termination_policy*stringTermination policy for the group vision plan. One of: end_of_month, fifteenth_of_month, last_work_date
cobra_rules*objecteligible: True if group plan is eligible for COBRA enrollments
plan_configuration*objectGroup plan configuration details
created*timestampThe date the record was created
modified*timestampThe date the record was last updated

Waiting periods

Each group plan may include one or more waiting period rules based on the information made available by the carrier.

Each waiting period will always have a waiting_period_enrollment_type field. The waiting_period_enrollment_type determines when the waiting period is used: new_member applies to new members enrolling as new hires, current_member applies to existing members enrolling with a QLE, and rehire applies to previously active members re-enrolling as a rehire.

Each waiting period will always have a waiting_period_rule field. This field is a general description of the waiting period rule, and determines which other fields will be present in the waiting period response.

Some waiting period rules have a waiting_period_coinciding flag. This flag is relevant when the rule defines a specific date for starting coverage and the member waiting period may end on that date.

For example, the waiting period rule may be '1st of month after hire date' for a new member with a hire date of January 1st. When waiting_period_coinciding is true, the member would begin coverage immediately in the coinciding period, starting on January 1st. When waiting_period_coinciding is false, the member coverage would be pushed out to the following period starting February 1st.

Fixed Waiting Period Object

ObjectTypeDescription
waiting_period_enrollment_type*stringEnrollment type to decide which relevant waiting period should be applied. One of: current_member, new_member, rehire
waiting_period_rule*stringWaiting period rule describing the waiting period for the member. One of: hire_date

Fixed Coinciding Waiting Period Object

ObjectTypeDescription
waiting_period_enrollment_type*stringEnrollment type to decide which relevant waiting period should be applied. One of: current_member, new_member, rehire
waiting_period_rule*stringWaiting period rule describing the waiting period for the member. One of: fifteenth_of_month_after_event, fifteenth_of_month_after_hire_date, first_of_month_after_event, first_of_month_after_hire_date, first_or_fifteenth_of_month_after_event, first_or_fifteenth_of_month_after_hire_date
waiting_period_coinciding*booleanTrue if the effective date can equal the final day of waiting period

Variable Waiting Period Object

ObjectTypeDescription
waiting_period_enrollment_type*stringEnrollment type to decide which relevant waiting period should be applied. One of: current_member, new_member, rehire
waiting_period_rule*stringWaiting period rule describing the waiting period for the member. One of: after_waiting_period
waiting_period_amount*integerAmount of time required for the waiting period
waiting_period_unit*stringUnit of time required for the waiting period. One of: business_day, day, month, week, year

Variable Coinciding Waiting Period Object

ObjectTypeDescription
waiting_period_enrollment_type*stringEnrollment type to decide which relevant waiting period should be applied. One of: current_member, new_member, rehire
waiting_period_rule*stringWaiting period rule describing the waiting period for the member. One of: fifteenth_of_month_after_waiting_period, first_of_month_after_waiting_period, first_or_fifteenth_of_month_after_waiting_period
waiting_period_amount*integerAmount of time required for the waiting period
waiting_period_unit*stringUnit of time required for the waiting period. One of: business_day, day, month, week, year
waiting_period_coinciding*booleanTrue if the effective date can equal the final day of waiting period

What’s Next

Get familiar with the member data available through Noyo