Skip to main content
{
    "snapshot_mode": "current_open",
    "employee": {
        "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-10-01"
            },
            "employment_dates": {
                "hire_date": "2022-10-01",
                "full_time_start": "2022-10-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": "single",
            "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"
            }
        }
    },
    "coverages": [
        {
            "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
            "line_of_coverage": "dental",
            "plan_id": "61b6d125-8bbf-483a-9920-f23d9442403d",
            "enrolled_members": [
                {
                    "individual_type": "employee",
                    "custom_individual_id": "1",
                    "effective_start_date": "2022-10-01",
                    "effective_end_date": "9999-12-31",
                    "latest_change_effective_date": "2022-10-01",
                    "event_id": "7"
                }
            ],
            "signature_date": "2022-09-27"
        },
        {
            "carrier_id": "2d370e0e-fd73-45e0-8828-796d2cacaeef",
            "line_of_coverage": "vision",
            "plan_id": "278942d6-0ee5-4275-a327-3f91dc25b451",
            "enrolled_members": [
                {
                    "individual_type": "employee",
                    "custom_individual_id": "1",
                    "effective_start_date": "2022-10-01",
                    "effective_end_date": "9999-12-31",
                    "latest_change_effective_date": "2022-10-01",
                    "event_id": "7"
                }
            ],
            "signature_date": "2022-09-27"
        }
    ],
    "enable_member_auto_link": false,
    "events": [
        {
            "id": "7",
            "type": "coverage",
            "reason": "new_hire",
            "date": "2022-10-01"
        }
    ]
}
1

Set a custom_individual_id in the initial request using your own internal identifier

After the member is created in the Noyo system, you can refer to them with either the Noyo ID (returned for all created members) or with your custom ID.
2

Set employment dates

"employment_dates": {
    "hire_date": "2022-10-01",
    "full_time_start": "2022-10-01"
}
3

Set coverages

Populate the payload with all active coverages, including coverages that are scheduled to become active in the future.
4

Set the event reason

Set the event reason to new_hire.
"events": [
    {
        "id": "7",
        "type": "coverage",
        "reason": "new_hire",
        "date": "2022-10-01"
    }
]
⌘I