coverages
array contains one entry for each carrier with which you would like to make changes to coverage. The carrier_id
along with the schema of the carrier_config
object will be provided by the Noyo team. You can reference the Get carrier configuration by group list to get additional carrier-specific data. The lines_of_coverage
object allows the following keys:
Key | Description |
---|---|
accident | Accident |
add | Accidental Death & Dismemberment |
cancer | Cancer |
critical_illness | Critical Illness |
dental | Dental |
hospital_indemnity | Hospital Indemnity |
life | Life |
ltd | Long Term Disability |
medical | Medical |
std | Short Term Disability |
vision | Vision |
coverages
array you can optionally specify a signature_date
. The signature_date
is the date when the employee or employer signed for the change to be made. If a signature_date
is not provided we will communicate the date the member request was received by the Noyo system as the signature_date
to the carrier.
signature_date | string | ISO-8601 date string for signature date |
lines_of_coverage
you may provide three different actions: adding_coverage
, removing_coverage
, and modifying_coverage
. More information about each of these is below.
adding_coverage
action is used to add new coverage for a member with a carrier. You must provide an adding_coverage
entry for each employee or dependent that is enrolling in coverage with the carrier along with the plan_id
. The plan_id
can be retrieved by Get group plan list.
medical
, dental
, vision
, accident
, cancer
or hospital_indemnity
coverageid * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member adding coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
life
, add
, std
, ltd
and critical_illness
coveragevolume
parameter in dollars (e.g. $50,000 should be sent as 50000
).
removing_coverage
action is used to remove coverage from a member with a carrier. The structure of the removing_coverage
action is below:
id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member removing coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
reason * | string | Reason the member is removing or canceling coverage. One of: medi-cal , medicaid , no-coverage , other-cobra , other-employee-group , other-ind-off-exchange , other-ind-on-exchange , other-medicare , other-parent-group , other-spouse-group , retiree-coverage , tricare-coverage , va-coverage , voluntary-withdrawal |
modifying_coverage
action is used to make changes to an existing coverage for a member / plan combination, given that the member already has coverage on that plan with the carrier. For example, you can use the modifying_coverage
action to change the volume of coverage for a member’s existing life or disability plan, or provide a new carrier_config
to remain on the same plan but move the member into a new subgroup or benefit class.
medical
, dental
, vision
, accident
, cancer
or hospital_indemnity
coverageid * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member modifying coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
life
, add
, std
, ltd
and critical_illness
coveragevolume
parameter in dollars (e.g. $50,000 should be sent as 50000
).
id * | uuid | Unique identifier of the employee or dependent in Noyo |
member_type * | string | Type of member modifying coverage. One of: dependent , employee |
plan_id | uuid | Unique identifier of the group plan in Noyo |
volume ˢ | integer | Elected volume for the type of coverage being selected |
coverages
array. For some carriers, there may be a single transaction including all of the requested changes, while other carriers may require separate transactions for each action type (i.e. one transaction per action per carrier).
completed
Resultstatus
of the member transaction will be updated and the result
of the member transaction will be in the same format as the member request result.