Create an Enrollment Snapshot Member Request

curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_requests/enrollment_snapshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coverages": [
    {
      "carrier_config": {},
      "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lines_of_coverage": {
        "accident": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "add": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "cancer": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "critical_illness": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "dental": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "health_fund": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "hospital_indemnity": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "life": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "ltd": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "medical": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "pharmacy": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "std": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "vision": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "wellness": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        }
      },
      "signature_date": "<string>"
    }
  ],
  "enrollment_type": "new_hire",
  "target_date": "<string>"
}
'

{
  "body": {},
  "created": 123,
  "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified": 123,
  "request_type": "demographic",
  "result": {},
  "status": "processing",
  "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "completed": 123,
  "transactions": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Requests

Create an Enrollment Snapshot Member Request

The Enrollment Snapshot Member Request allows you to communicate the desired state of an employee’s coverage elections during an employee’s new hire period. You can use it in one of two cases:

To enroll an employee and their dependents for the first time. Please reference the New Hire Enrollment documentation section for more details.
To amend and replace a previous New Hire member request with the latest complete set of coverage elections, described in this section below.

POST

api

employees

{employee_id}

member_requests

enrollment_snapshot

Create an Enrollment Snapshot Member Request

curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_requests/enrollment_snapshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "coverages": [
    {
      "carrier_config": {},
      "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lines_of_coverage": {
        "accident": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "add": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "cancer": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "critical_illness": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "dental": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "health_fund": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "hospital_indemnity": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "life": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "ltd": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "medical": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "pharmacy": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "std": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "volume": 123
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "vision": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        },
        "wellness": {
          "enrolling_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ],
          "waiving_members": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "member_type": "dependent",
              "reason": "other-employee-group",
              "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        }
      },
      "signature_date": "<string>"
    }
  ],
  "enrollment_type": "new_hire",
  "target_date": "<string>"
}
'

{
  "body": {},
  "created": 123,
  "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified": 123,
  "request_type": "demographic",
  "result": {},
  "status": "processing",
  "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "completed": 123,
  "transactions": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

The Member Request workflow is now deprecated in favor of using Member Snapshot

Authorizations

Authorization

string

header

required

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

Path Parameters

employee_id

string<uuid>

required

The unique identifier of the employee related to the member request

Example:

"72af10df-a8b3-46f1-a114-ac36d4b8a6ea"

Body

application/json

coverages

object[]

required

List of coverages being added or waived with a set of carriers

Minimum array length: 1

Show child attributes

coverages.carrier_config

object

required

Carrier-specific data required for new hire enrollment

coverages.carrier_id

string<uuid>

required

Unique identifier of the carrier in the Noyo system

coverages.lines_of_coverage

object

required

Enrollment and waiving information for each line of coverage

Show child attributes

coverages.lines_of_coverage.accident

object

Member transaction requests relating to accident coverage

Show child attributes

coverages.lines_of_coverage.accident.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.accident.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.accident.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.accident.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.accident.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.accident.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.accident.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.accident.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.accident.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.add

object

Member transaction requests relating to AD&D coverage

Show child attributes

coverages.lines_of_coverage.add.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.add.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.add.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.add.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.add.enrolling_members.volume

integer<int32>

Elected volume for the type of coverage being selected

coverages.lines_of_coverage.add.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.add.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.add.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.add.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.add.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.cancer

object

Member transaction requests relating to cancer coverage

Show child attributes

coverages.lines_of_coverage.cancer.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.cancer.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.cancer.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.cancer.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.cancer.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.cancer.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.cancer.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.cancer.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.cancer.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.critical_illness

object

Member transaction requests relating to critical illness coverage

Show child attributes

coverages.lines_of_coverage.critical_illness.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.critical_illness.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.critical_illness.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.critical_illness.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.critical_illness.enrolling_members.volume

integer<int32>

Elected volume for the type of coverage being selected

coverages.lines_of_coverage.critical_illness.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.critical_illness.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.critical_illness.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.critical_illness.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.critical_illness.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.dental

object

Member transaction requests relating to dental coverage

Show child attributes

coverages.lines_of_coverage.dental.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.dental.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.dental.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.dental.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.dental.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.dental.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.dental.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.dental.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.dental.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.health_fund

object

Member transaction requests relating to health fund coverage

Show child attributes

coverages.lines_of_coverage.health_fund.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.health_fund.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.health_fund.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.health_fund.enrolling_members.plan_id

string<uuid>

required

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.health_fund.enrolling_members.volume

integer<int32>

Elected volume for the type of coverage being selected

coverages.lines_of_coverage.health_fund.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.health_fund.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.health_fund.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.health_fund.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.health_fund.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.hospital_indemnity

object

Member transaction requests relating to hospital indemnity coverage

Show child attributes

coverages.lines_of_coverage.hospital_indemnity.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.hospital_indemnity.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.hospital_indemnity.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.hospital_indemnity.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.hospital_indemnity.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.hospital_indemnity.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.hospital_indemnity.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.hospital_indemnity.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.hospital_indemnity.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.life

object

Member transaction requests relating to life coverage

Show child attributes

coverages.lines_of_coverage.life.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.life.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.life.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.life.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.life.enrolling_members.volume

integer<int32>

Elected volume for the type of coverage being selected

coverages.lines_of_coverage.life.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.life.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.life.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.life.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.life.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.ltd

object

Member transaction requests relating to LTD coverage

Show child attributes

coverages.lines_of_coverage.ltd.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.ltd.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.ltd.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.ltd.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.ltd.enrolling_members.volume

integer<int32>

Elected volume for the type of coverage being selected

coverages.lines_of_coverage.ltd.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.ltd.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.ltd.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.ltd.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.ltd.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.medical

object

Member transaction requests relating to medical coverage

Show child attributes

coverages.lines_of_coverage.medical.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.medical.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.medical.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.medical.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.medical.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.medical.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.medical.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.medical.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.medical.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.pharmacy

object

Member transaction requests relating to pharmacy coverage

Show child attributes

coverages.lines_of_coverage.pharmacy.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.pharmacy.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.pharmacy.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.pharmacy.enrolling_members.plan_id

string<uuid>

required

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.pharmacy.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.pharmacy.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.pharmacy.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.pharmacy.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.pharmacy.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.std

object

Member transaction requests relating to STD coverage

Show child attributes

coverages.lines_of_coverage.std.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.std.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.std.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.std.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.std.enrolling_members.volume

integer<int32>

Elected volume for the type of coverage being selected

coverages.lines_of_coverage.std.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.std.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.std.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.std.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.std.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.vision

object

Member transaction requests relating to vision coverage

Show child attributes

coverages.lines_of_coverage.vision.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.vision.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.vision.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.vision.enrolling_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.vision.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.vision.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.vision.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.vision.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.vision.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.wellness

object

Member transaction requests relating to wellness coverage

Show child attributes

coverages.lines_of_coverage.wellness.enrolling_members

object[]

Details for members enrolling in coverage

Show child attributes

coverages.lines_of_coverage.wellness.enrolling_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.wellness.enrolling_members.member_type

enum<string>

required

Type of member adding coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.wellness.enrolling_members.plan_id

string<uuid>

required

Unique identifier of the group plan in Noyo

coverages.lines_of_coverage.wellness.waiving_members

object[]

Details for members waiving coverage

Show child attributes

coverages.lines_of_coverage.wellness.waiving_members.id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

coverages.lines_of_coverage.wellness.waiving_members.member_type

enum<string>

required

Type of member waiving coverage

Available options:

dependent,

employee

coverages.lines_of_coverage.wellness.waiving_members.reason

enum<string>

required

Reason the member is waiving coverage

Available options:

other-employee-group,

other-spouse-group,

other-parent-group,

other-ind-on-exchange,

other-ind-off-exchange,

other-cobra,

other-medicare,

medicaid,

medi-cal,

va-coverage,

tricare-coverage,

retiree-coverage,

no-coverage,

voluntary-withdrawal

coverages.lines_of_coverage.wellness.waiving_members.plan_id

string<uuid>

Unique identifier of the group plan in Noyo

coverages.signature_date

string

ISO-8601 date string for signature date

enrollment_type

enum<string>

required

Enrollment type of the enrollment snapshot member request

Available options:

new_hire

target_date

string

Date when the enrollment snapshot is effective

Response

201 - application/json

Successful Response - Returns the new Member Request

body

object

required

Data required to execute a member request, varies depending on the request type

created

integer

required

The date the record was created

employee_id

string<uuid>

required

Unique identifier of the employee in Noyo

string<uuid>

required

Unique identifier of the record in Noyo

modified

integer

required

The date the record was last updated

request_type

enum<string>

required

Transaction type for the member request

Available options:

demographic,

new_hire,

termination,

open_enrollment,

qualifying_life_event,

enrollment_snapshot,

cobra_enrollment,

cobra_termination,

cobra_open_enrollment,

cobra_qualifying_life_event

result

object

required

Result from executing the member request, varies depending on the request type

status

enum<string>

required

Status of the member request

Available options:

processing,

completed,

failed,

canceled

version

string<uuid>

required

Current version of the record

completed

integer

Timestamp indicating when a member request was marked as completed

transactions

string<uuid>[]

List of unique identifiers of all associated member transactions in Noyo

Create a new Dependent Create a New Hire Enrollment Member Request

⌘I

Groups

Members

Changes

Legacy

Create an Enrollment Snapshot Member Request

Authorizations

Path Parameters

Body

Response