Individual Enrollments

Get a list of all Individual Enrollments for an Employee

curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/individual_enrollments \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "offset": 1,
    "page_num": 2,
    "page_size": 2,
    "total_records": 1
  },
  "response": [
    {
      "cobra_enrollment": {
        "cobra_enrolled": true,
        "cobra_type": "federal"
      },
      "created": 123,
      "enroll_data": {},
      "group_enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_enrollment_configuration": {},
      "individual_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_type": "employee",
      "line_of_coverage": "dental",
      "modified": 123,
      "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cobra_details": {
        "eligibility_start_date": "2023-12-25",
        "eligibility_end_date": "2023-12-25",
        "qualifying_event_date": "2023-12-25",
        "qualifying_event_reason": "termination_of_employment"
      },
      "effective_end_date": "2017-01-17",
      "effective_start_date": "2017-01-17",
      "pcp_details": {
        "providers": [
          {
            "identification_code": "<string>",
            "identification_code_type": "service_provider_number",
            "entity_identifier_code": "pcp",
            "entity_type": "person",
            "first_name": "<string>",
            "last_name": "<string>",
            "middle_name": "<string>",
            "organization_name": "<string>",
            "patient_relationship_code": "established"
          }
        ]
      }
    }
  ]
}

GET

api

employees

{employee_id}

individual_enrollments

Get a list of all Individual Enrollments for an Employee

curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/individual_enrollments \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "offset": 1,
    "page_num": 2,
    "page_size": 2,
    "total_records": 1
  },
  "response": [
    {
      "cobra_enrollment": {
        "cobra_enrolled": true,
        "cobra_type": "federal"
      },
      "created": 123,
      "enroll_data": {},
      "group_enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_enrollment_configuration": {},
      "individual_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_type": "employee",
      "line_of_coverage": "dental",
      "modified": 123,
      "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "active",
      "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cobra_details": {
        "eligibility_start_date": "2023-12-25",
        "eligibility_end_date": "2023-12-25",
        "qualifying_event_date": "2023-12-25",
        "qualifying_event_reason": "termination_of_employment"
      },
      "effective_end_date": "2017-01-17",
      "effective_start_date": "2017-01-17",
      "pcp_details": {
        "providers": [
          {
            "identification_code": "<string>",
            "identification_code_type": "service_provider_number",
            "entity_identifier_code": "pcp",
            "entity_type": "person",
            "first_name": "<string>",
            "last_name": "<string>",
            "middle_name": "<string>",
            "organization_name": "<string>",
            "patient_relationship_code": "established"
          }
        ]
      }
    }
  ]
}

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 for which you would like to view individual enrollments

Example:

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

Query Parameters

effective_date

string

The relative date on which to view the state of the record

include_dependents

string

Boolean, use "true" to include dependent individual enrollments in the results

page_size

integer

The max size of each page of results

offset

integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

Response

200 - application/json

Successful Response - Returns all matching Individual Enrollments

meta

object

required

Metadata associated with the response data

Show child attributes

meta.offset

integer<int32>

required

The offset of the first response record within the matching data set

Required range: x >= 0

meta.page_num

integer<int32>

required

The page number of the response records within the overall data set (1-based integer)

Required range: x >= 1

meta.page_size

integer<int32>

required

The maximum number of response records on each page of results

Required range: x >= 1

meta.total_records

integer<int32>

The total number of records in the entire matching data set

Required range: x >= 0

response

object[]

required

List of individual enrollment results

Show child attributes

response.cobra_enrollment

object

required

Details about the member COBRA enrollment status, if applicable

Show child attributes

response.cobra_enrollment.cobra_enrolled

boolean

True if member is enrolled in COBRA coverage

response.cobra_enrollment.cobra_type

enum<string>

Type of COBRA enrollment for the member

Available options:

federal,

state

response.created

integer

required

The date the record was created

response.enroll_data

object

required

Line of coverage specific enroll data with volume information

response.group_enrollment_id

string<uuid>

required

Unique identifier of the group enrollment in Noyo

response.id

string<uuid>

required

Unique identifier of the record in Noyo

response.individual_enrollment_configuration

object

required

Carrier-specific details describing the individual enrollment configuration

response.individual_id

string<uuid>

required

Unique identifier of the employee or dependent in Noyo

response.individual_type

enum<string>

required

Type of member for the individual enrollment

Available options:

dependent,

employee

Example:

"employee"

response.line_of_coverage

enum<string>

required

Line of coverage for the individual enrollment

Available options:

medical,

dental,

vision,

life,

add,

std,

ltd,

accident,

critical_illness,

cancer,

health_fund,

hospital_indemnity,

pharmacy,

wellness

Example:

"dental"

response.modified

integer

required

The date the record was last updated

response.plan_id

string<uuid>

required

Unique identifier of the group plan in Noyo

response.status

enum<string>

required

Status of the individual enrollment

Available options:

pending,

active,

waived,

terminated

Example:

"active"

response.version

string<uuid>

required

Current version of the record

response.cobra_details

object

Show child attributes

response.cobra_details.eligibility_start_date

string<date>

required

The date which represents when the individual is first eligible for COBRA

response.cobra_details.eligibility_end_date

string<date>

The date which represents when the individual is no longer eligible for COBRA

response.cobra_details.qualifying_event_date

string<date>

The date of the event which qualified the individual for COBRA

response.cobra_details.qualifying_event_reason

enum<string>

The reason of the event which qualified the individual for COBRA

Available options:

termination_of_employment,

reduction_of_work_hours,

medicare,

death,

divorce,

separation,

ineligible_child,

bankruptcy_of_retirees_former_employer,

layoff,

leave_of_absence

response.effective_end_date

string<date>

ISO-8601 date string for the effective date of the coverage

Example:

"2017-01-17"

response.effective_start_date

string<date>

ISO-8601 date string for the effective date of the coverage

Example:

"2017-01-17"

response.pcp_details

object

Show child attributes

response.pcp_details.providers

object[]

required

List of primary care providers

Show child attributes

response.pcp_details.providers.identification_code

string

required

Code of the identification

response.pcp_details.providers.identification_code_type

enum<string>

required

Type of the identification code

Available options:

service_provider_number,

national_provider_identifier

response.pcp_details.providers.entity_identifier_code

enum<string>

Code of the entity identifier

Available options:

pcp,

dental_pcp,

obgyn

response.pcp_details.providers.entity_type

enum<string>

Type of entity

Available options:

person,

non_person_entity

response.pcp_details.providers.first_name

string

First name of the primary care provider

response.pcp_details.providers.last_name

string

Last name of the primary care provider

response.pcp_details.providers.middle_name

string

Middle name of the primary care provider

response.pcp_details.providers.organization_name

string

Organization name of the primary care provider.

response.pcp_details.providers.patient_relationship_code

enum<string>

Code which represents the relationship of the patient to the primary care provider

Available options:

established,

not_established,

unknown

Get Employee Dependent Get Individual Enrollment

⌘I

Groups

Members

Changes

Legacy

Individual Enrollments

Authorizations

Path Parameters

Query Parameters

Response