Skip to main content
GET
/
api
/
v1
/
member_snapshots
/
{snapshot_id}
Get a Member Snapshot
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/member_snapshots/{snapshot_id} \
  --header 'Authorization: Bearer <token>'
{
  "created": 1656030390,
  "created_members": [
    {
      "custom_individual_id": "bb6bfcd8-6657-4b77-8151-949ea8b5e44e",
      "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb",
      "type": "employee"
    },
    {
      "custom_individual_id": "3f093cc0-4fef-4d5d-9267-ba5cdfc09827",
      "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": "3f093cc0-4fef-4d5d-9267-ba5cdfc09827",
        "event_id": "1",
        "id": "ab740704-7c37-4010-92b3-d22c6926be3e",
        "person": {
          "contact": {
            "email_address": "[email protected]",
            "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": "bb6bfcd8-6657-4b77-8151-949ea8b5e44e",
      "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": "[email protected]",
          "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"
      }
    },
    "events": [
      {
        "date": "2022-01-01",
        "id": "1",
        "reason": "open_enrollment",
        "type": "enrollment"
      }
    ],
    "snapshot_mode": "current_open"
  },
  "modified": 1656030390,
  "replaced_by": "9aea70ac-469d-560b-2512-90be9e2348ys",
  "status": "processing",
  "version": "271c60d6-f009-4b3d-8bba-aac49b2dd9a4",
  "warnings": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
snapshot_id
string<uuid>
required

The unique identifier of the member snapshot

Example:

"30b74a44-d5b1-4123-a7a4-6d3aec251ba4"

Response

Successful Response - Returns the Member Snapshot contents

​
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