Skip to main content
POST
/
api
/
v1
/
groups
/
{group_id}
/
member_snapshots
Create a Member Snapshot
curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/member_snapshots \
  --header 'Content-Type: application/json' \
  --data '{
  "coverages": [
    {
      "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
      "enrolled_members": [
        {
          "effective_end_date": "9999-12-31",
          "effective_start_date": "2022-01-01",
          "event_id": "1",
          "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
          "individual_type": "employee",
          "latest_change_effective_date": "2022-02-13"
        },
        {
          "effective_end_date": "9999-12-31",
          "effective_start_date": "2022-01-01",
          "event_id": "1",
          "individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
          "individual_type": "dependent"
        }
      ],
      "line_of_coverage": "medical",
      "plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9",
      "signature_date": "2021-12-23"
    },
    {
      "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
      "enrolled_members": [
        {
          "effective_end_date": "9999-12-31",
          "effective_start_date": "2022-01-01",
          "event_id": "1",
          "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
          "individual_type": "employee"
        },
        {
          "effective_end_date": "2021-12-31",
          "effective_start_date": "2022-01-01",
          "event_id": "1",
          "individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
          "individual_type": "dependent"
        }
      ],
      "line_of_coverage": "dental",
      "plan_name": "DHMO Smile Plus",
      "signature_date": "2021-12-23"
    },
    {
      "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
      "enrolled_members": [
        {
          "effective_end_date": "9999-12-31",
          "effective_start_date": "2022-01-01",
          "event_id": "1",
          "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
          "individual_type": "employee",
          "volume": 50000
        }
      ],
      "line_of_coverage": "life",
      "plan_name": "50k Employee Basic Life",
      "signature_date": "2021-12-23"
    }
  ],
  "dependents": [
    {
      "custom_individual_id": "378713198",
      "event_id": "1",
      "id": "ab740704-7c37-4010-92b3-d22c6926be3e",
      "person": {
        "contact": {
          "email_address": "jamie@testemail.com",
          "email_address_type": "home",
          "home_phone": "+12065551234"
        },
        "date_of_birth": "1990-01-02",
        "first_name": "Jamie",
        "home_address": {
          "city": "San Francisco",
          "county": "San Francisco",
          "state": "CA",
          "street_one": "1234 Home Ave",
          "zip_code": "94107"
        },
        "last_name": "Johnson",
        "mailing_address": {
          "city": "San Francisco",
          "state": "CA",
          "street_one": "P.O. Box 1234",
          "zip_code": "94107"
        },
        "marital_status": "married",
        "sex": "F",
        "ssn": "987654321"
      },
      "relationship": "spouse"
    }
  ],
  "employee": {
    "classifications": {
      "BranchName": "HQ",
      "Department": "Sales"
    },
    "custom_individual_id": "718713143",
    "employment": {
      "employment_dates": {
        "full_time_start": "2015-01-01",
        "hire_date": "2014-12-10"
      },
      "employment_status": "full-time",
      "hours_worked": 50,
      "occupation": "Senior Analyst",
      "salary": {
        "amount": 55000,
        "effective_date": "2022-01-31",
        "type": "salary",
        "unit": "annual"
      }
    },
    "event_id": "1",
    "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
    "person": {
      "contact": {
        "email_address": "david@testemail.com",
        "email_address_type": "home",
        "home_phone": "+12065551234",
        "preferred_method": "email",
        "work_phone": "+12065559876"
      },
      "date_of_birth": "1985-06-22",
      "first_name": "David",
      "home_address": {
        "city": "San Francisco",
        "county": "San Francisco",
        "state": "CA",
        "street_one": "1234 Home Ave",
        "zip_code": "94107"
      },
      "last_name": "Johnson",
      "mailing_address": {
        "city": "San Francisco",
        "state": "CA",
        "street_one": "P.O. Box 1234",
        "zip_code": "94107"
      },
      "marital_status": "married",
      "middle_name": "A",
      "sex": "M",
      "ssn": "123456789",
      "suffix": "Jr"
    }
  },
  "enable_member_auto_link": false,
  "events": [
    {
      "date": "2022-01-01",
      "id": "1",
      "reason": "open_enrollment",
      "type": "coverage"
    }
  ],
  "snapshot_mode": "current_open"
}'
{
  "created": 1656030390,
  "created_members": [
    {
      "custom_individual_id": "718713143",
      "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
      "type": "employee"
    },
    {
      "custom_individual_id": "378713198",
      "id": "ab740704-7c37-4010-92b3-d22c6926be3e",
      "type": "dependent"
    }
  ],
  "employee_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
  "fulfillment_summary": [
    {
      "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
      "errors": [],
      "status": "processing"
    }
  ],
  "id": "7bea80ac-499d-560b-5512-60be9e2349cb",
  "member_snapshot": {
    "coverages": [
      {
        "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
        "enrolled_members": [
          {
            "effective_end_date": "9999-12-31",
            "effective_start_date": "2022-01-01",
            "event_id": "1",
            "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
            "individual_type": "employee",
            "latest_change_effective_date": "2022-02-13"
          },
          {
            "effective_end_date": "9999-12-31",
            "effective_start_date": "2022-01-01",
            "event_id": "1",
            "individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
            "individual_type": "dependent"
          }
        ],
        "line_of_coverage": "medical",
        "plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9",
        "signature_date": "2021-12-23"
      },
      {
        "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
        "enrolled_members": [
          {
            "effective_end_date": "9999-12-31",
            "effective_start_date": "2022-01-01",
            "event_id": "1",
            "individual_type": "employee"
          },
          {
            "effective_end_date": "2021-12-31",
            "effective_start_date": "2022-01-01",
            "event_id": "1",
            "individual_id": "ab740704-7c37-4010-92b3-d22c6926be3e",
            "individual_type": "dependent"
          }
        ],
        "line_of_coverage": "dental",
        "plan_name": "DHMO Smile Plus",
        "signature_date": "2021-12-23"
      },
      {
        "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
        "enrolled_members": [
          {
            "effective_end_date": "9999-12-31",
            "effective_start_date": "2022-01-01",
            "event_id": "1",
            "individual_type": "employee",
            "volume": 50000
          }
        ],
        "line_of_coverage": "life",
        "plan_name": "50k Employee Basic Life",
        "signature_date": "2021-12-23"
      }
    ],
    "dependents": [
      {
        "custom_individual_id": "378713198",
        "event_id": "1",
        "id": "ab740704-7c37-4010-92b3-d22c6926be3e",
        "person": {
          "contact": {
            "email_address": "jamie@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
          },
          "date_of_birth": "1990-01-02",
          "first_name": "Jamie",
          "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
          },
          "last_name": "Johnson",
          "mailing_address": {
            "city": "San Francisco",
            "state": "CA",
            "street_one": "P.O. Box 1234",
            "zip_code": "94107"
          },
          "marital_status": "married",
          "sex": "F",
          "ssn": "987654321"
        },
        "relationship": "spouse"
      }
    ],
    "employee": {
      "classifications": {
        "BranchName": "HQ",
        "Department": "Sales"
      },
      "custom_individual_id": "718713143",
      "employment": {
        "employment_dates": {
          "full_time_start": "2015-01-01",
          "hire_date": "2014-12-10"
        },
        "employment_status": "full-time",
        "hours_worked": 50,
        "occupation": "Senior Analyst",
        "salary": {
          "amount": 55000,
          "effective_date": "2022-01-31",
          "type": "salary",
          "unit": "annual"
        }
      },
      "event_id": "1",
      "group_id": "d0ec3837-3499-4a2f-8c58-966ef7e46d95",
      "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
      "person": {
        "contact": {
          "email_address": "david@testemail.com",
          "email_address_type": "home",
          "home_phone": "+12065551234",
          "preferred_method": "email",
          "work_phone": "+12065559876"
        },
        "date_of_birth": "1985-06-22",
        "first_name": "David",
        "home_address": {
          "city": "San Francisco",
          "county": "San Francisco",
          "state": "CA",
          "street_one": "1234 Home Ave",
          "zip_code": "94107"
        },
        "last_name": "Johnson",
        "mailing_address": {
          "city": "San Francisco",
          "state": "CA",
          "street_one": "P.O. Box 1234",
          "zip_code": "94107"
        },
        "marital_status": "married",
        "middle_name": "A",
        "sex": "M",
        "ssn": "123456789",
        "suffix": "Jr"
      }
    },
    "enable_member_auto_link": false,
    "events": [
      {
        "date": "2022-01-01",
        "id": "1",
        "reason": "open_enrollment",
        "type": "coverage"
      }
    ],
    "snapshot_mode": "current_open"
  },
  "modified": 1656030390,
  "status": "processing",
  "version": "271c60d6-f009-4b3d-8bba-aac49b2dd9a4",
  "warnings": []
}

Path Parameters

​
group_id
string<uuid>
required

The unique identifier of the group for the employee referenced in the snapshot

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Body

application/json
​
employee
object
required

Demographic information for the employee

​
snapshot_mode
enum<string>
required

Mode describing how the contents of the snapshot will be processed

Available options:
current_open
Example:

"current_open"

​
coverages
object[]

List of coverage and enrollment decisions for each member

​
dependents
object[]

List of demographic information for each dependent

​
enable_member_auto_link
boolean
default:false

Boolean flag for autolinking workflow

​
events
object[]

List of events associated with member and coverage updates

​
omitted_coverage_handling
object

Configuration for handling omitted coverages

Response

Successful Response - Returns the contents of the newly created Member Snapshot

​
created
integer
required

The date the record was created

​
created_members
object[]
required

List of created members

​
employee_id
string<uuid>
required

Unique ID of the employee in Noyo

​
id
string<uuid>
required

Unique identifier of the record in Noyo

​
member_snapshot
object
required

Member snapshot post Noyo processing (e.g. adding omitted coverages, applying rulesets, etc.)

​
modified
integer
required

The date the record was last updated

​
status
enum<string>
required

Status of the member snapshot

Available options:
processing,
completed,
replaced,
canceled,
submitted
​
version
string<uuid>
required

Current version of the record

​
warnings
string[]
required

Warnings generated during processing of the member snapshot

​
fulfillment_summary
object[]

List of member snapshot fulfillment statuses per carrier

​
inbound_snapshot
string

Exact member snapshot as received by Noyo and prior to any processing (e.g. adding omitted coverages, applying rulesets, etc.)

​
replaced_by
string<uuid>

UUID of the member snapshot that replaced the returned snapshot

⌘I