Skip to main content
{
    "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": []
}

{
"employee": {
    "id": "52b8ff36-388a-4faf-bc42-df446f13b89a",
    "custom_individual_id": "1",
    "classifications": {
        "BranchName": "HQ",
        "Department": "Sales"
    },
    "employment": {
        "employment_status": "full-time",
        "occupation": "Senior Analyst",
        "hours_worked": 50,
        "salary": {
            "amount": 155000,
            "unit": "annual",
            "type": "salary",
            "effective_date": "2022-01-01"
        },
        "employment_dates": {
            "hire_date": "2021-12-20",
            "full_time_start": "2022-01-01"
        }
    },
    "person": {
        "first_name": "Wile",
        "middle_name": "E",
        "last_name": "Runner",
        "suffix": "Jr",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "1949-06-22",
        "ssn": "123456789",
        "sex": "M",
        "marital_status": "married",
        "contact": {
            "home_phone": "+12065551234",
            "work_phone": "+12065559876",
            "email_address": "wile@testemail.com",
            "email_address_type": "home",
            "preferred_method": "email"
        },
        "mailing_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        }
    }
},
"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"
            }
        ]
    }
]
}
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.