Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.noyo.com/llms.txt

Use this file to discover all available pages before exploring further.

{
    "snapshot_mode": "current_open",
    "employee": {} // omitted for brevity
    "dependents": [],
    "coverages": [
        {
            "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
            "line_of_coverage": "dental",
            "plan_id": "4774b2bb-1580-437c-9b53-eb9500f9421c",
            "enrolled_members": [
                {
                    "individual_id": "52b8ff36-388a-4faf-bc42-df446f13b89a",
                    "individual_type": "employee",
                    "effective_start_date": "2022-01-01",
                    "effective_end_date": "9999-12-31"
                }
            ]
        },
        {
            "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
            "line_of_coverage": "vision",
            "plan_id": "3a25b5b7-0679-4dba-b9c1-b32336cbb1a7",
            "enrolled_members": [
                {
                    "individual_type": "employee",
                    "individual_id": "52b8ff36-388a-4faf-bc42-df446f13b89a",
                    "effective_start_date": "2022-10-01",
                    "effective_end_date": "9999-12-31",
                    "event_id": "4562"
                }
            ]
        }
    ],
    "events": [
        {
            "id": "4562",
            "date": "2022-09-27",
            "type": "coverage",
            "reason": "new_hire"
        }
    ],
    "warnings": []
}
1

Current state

The current state of the family, before the new line of coverage is added. The current state of a family can be retrieved in the form of a member snapshot via the GET Member Snapshot by Employee ID endpoint.
2

Add coverage

Add a new coverage block for the vision plan the employee is being enrolled in.
3

Set event reason

Set the coverage event reason to new_hire.