Noyo Member Requests API
The Member Requests API from Noyo — 17 operation(s) for member requests.
OpenAPI Specification
openapi: 3.0.1
info:
description: APIs to manage and consume information about Carriers
title: Noyo Carrier Carrier Mapped Field Member Requests API
version: 1.0.0
servers: []
tags:
- name: Member Requests
paths:
/api/v1/employees/{employee_id}/member_requests:
x-summary: List Member Requests
get:
description: Returns a list of all member requests for a given employee. Each member request may have one or more associated member transactions.
operationId: getEmployeeMemberRequestList
parameters:
- description: The unique identifier of the employee for which you would like to view member requests
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 2
response:
- body:
coverages:
- carrier_config:
bill_group: '1000001'
member_group: '99999'
carrier_id: d0003042-eaae-4491-b219-4825456a3d16
lines_of_coverage:
dental:
waiving_members:
- id: f471a562-fa8f-41c9-93fd-12b372e16c72
member_type: employee
reason: other-spouse-group
completed: 1557565200
created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: 4f57e463-f4d5-4255-83d4-806b0cabaac5
modified: 1557565200
request_type: new_hire
status: processing
transactions:
- a6e30204-87b2-4802-95a4-a156bd0f7435
- body:
employee_id: 6dc22bed-27fc-458c-b732-bdaf5b5a1031
last_work_date: '2018-01-15'
reason: voluntary
completed: 1557565200
created: 1557512394
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1
modified: 1557565200
request_type: termination
status: processing
transactions:
- f4ecdaa5-e019-4a24-98c7-2caee9a58ccd
schema:
$ref: '#/components/schemas/PaginatedMemberRequestResult'
description: Successful Response - Returns all matching Member Requests
summary: Get all Member Requests for Employee
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/cobra_enrollment:
x-summary: COBRA Emrollment
post:
description: 'The COBRA enrollment member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers. This is for a continuation of benefits situation, when main line coverage either has already been terminated, or will be in conjunction with this member request.
'
operationId: cobraEnrollmentMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
summary: A COBRA Enrollment request with employee and dependent enrollment actions
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
dental:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: ff033377-59e2-40df-8206-8cec3a725411
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: ff033377-59e2-40df-8206-8cec3a725411
vision:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
signature_date: '2020-01-15'
termination_info:
last_work_date: '2020-01-01'
reason: voluntary
schema:
$ref: '#/components/schemas/MemberRequestCOBRAEnrollmentRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
dental:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: ff033377-59e2-40df-8206-8cec3a725411
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: ff033377-59e2-40df-8206-8cec3a725411
vision:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
signature_date: '2020-01-15'
termination_info:
last_work_date: '2020-01-01'
reason: voluntary
created: 1557512389
employee_id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
id: 4f57e463-f4d5-4255-83d4-806b0cabaac5
modified: 1564440756
request_type: cobra_enrollment
result: {}
status: processing
transactions:
- a6e30204-87b2-4802-95a4-a156bd0f7435
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a COBRA Enrollment Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/cobra_open_enrollment:
x-summary: COBRA Open Enrollment
post:
description: The COBRA open enrollment member request is used to make changes to employees, dependents and COBRA coverages during the open enrollment period.
operationId: cobraOpenEnrollmentMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
summary: Member request to add COBRA coverage to a dependent during the open enrollment period.
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
signature_date: '2021-01-15'
schema:
$ref: '#/components/schemas/MemberRequestCOBRAOpenEnrollmentRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
signature_date: '2021-01-15'
created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: f4517b87-275a-42e1-85e5-47ea6ab5312b
modified: 1564440756
request_type: cobra_open_enrollment
status: processing
transactions:
- 579952dd-9a66-4587-a4f7-72a63bf9ec86
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a COBRA Open Enrollment Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/cobra_qualifying_life_event:
x-summary: COBRA Qualifying Life Event
post:
description: The COBRA qualifying life event member request is used to make changes to employees, dependents and COBRA coverages due to a qualifying life event.
operationId: cobraQualifyingLifeEventMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
summary: A COBRA Qualifying Life Event member request with employee and dependent enrollment actions
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
signature_date: '2021-01-15'
event:
event_date: '2021-01-01'
event_type: newborn
schema:
$ref: '#/components/schemas/MemberRequestCOBRAQualifyingLifeEventRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
signature_date: '2021-01-15'
event:
event_date: '2021-01-01'
event_type: newborn
created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: f4517b87-275a-42e1-85e5-47ea6ab5312b
modified: 1564440756
request_type: cobra_qualifying_life_event
status: processing
transactions:
- 579952dd-9a66-4587-a4f7-72a63bf9ec86
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a COBRA Qualifying Life Event Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/cobra_termination:
x-summary: COBRA Termination
post:
description: The COBRA termination member request is used to remove an employee and their dependents from COBRA coverage at all carriers. The `cobra_termination_date` is the date on which the COBRA coverage should be terminated.
operationId: cobraTerminationMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 6dc22bed-27fc-458c-b732-bdaf5b5a1031
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
summary: Member Request to successfully terminate an employee from COBRA
value:
cobra_termination_date: '2021-01-15'
reason: voluntary
signature_date: '2021-01-01'
schema:
$ref: '#/components/schemas/MemberRequestCOBRATerminationRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
cobra_termination_date: '2021-01-15'
reason: voluntary
signature_date: '2021-01-01'
created: 1557512389
employee_id: 6dc22bed-27fc-458c-b732-bdaf5b5a1031
id: dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1
modified: 1564440756
request_type: cobra_termination
status: processing
transactions:
- f4ecdaa5-e019-4a24-98c7-2caee9a58ccd
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a COBRA Termination Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/demographic:
x-summary: Demographic Change Member Request
post:
description: The demographic change member request is used to update information such as name, address, and salary for one or many members. The updates will be carried out for each carrier that has a record of each member.
operationId: demographicChangeMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
change_date: '2020-01-15'
member_changes:
- contact_change:
email_address: david.williamson@example.com
email_address_type: home
home_phone: '+15555551212'
work_phone: '+15555551212'
member:
id: f471a562-fa8f-41c9-93fd-12b372e16c72
type: employee
name_change:
first_name: David
last_name: Williamson
salary_change:
amount: 55000
type: salary
unit: annual
signature_date: '2020-01-15'
schema:
$ref: '#/components/schemas/MemberRequestDemographicChangeRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
change_date: '2020-01-15'
member_changes:
- contact_change:
email_address: david.williamson@example.com
email_address_type: home
home_phone: '+15555551212'
work_phone: '+15555551212'
member:
id: f471a562-fa8f-41c9-93fd-12b372e16c72
member_type: employee
name_change:
first_name: David
last_name: Williamson
salary_change:
amount: 55000
type: salary
unit: annual
signature_date: '2020-01-15'
created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: db6f362a-9f90-49b2-a73d-830cd2726537
modified: 1564440756
request_type: demographic
status: processing
transactions:
- b56bfe70-2632-49e9-b269-1eaa36ed7fd6
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a Demographic Change Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/enrollment_snapshot:
x-summary: Enrollment Snapshot
post:
description: '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](#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.
'
operationId: createEnrollmentSnapshotMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
summary: An Enrollment Snapshot request with employee and dependents enrolling or waiving
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
dental:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: ff033377-59e2-40df-8206-8cec3a725411
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: ff033377-59e2-40df-8206-8cec3a725411
vision:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
signature_date: '2020-01-15'
enrollment_type: new_hire
schema:
$ref: '#/components/schemas/MemberRequestEnrollmentSnapshotRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
dental:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: ff033377-59e2-40df-8206-8cec3a725411
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: ff033377-59e2-40df-8206-8cec3a725411
vision:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
signature_date: '2020-01-15'
enrollment_type: new_hire
created: 1557512389
employee_id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
id: 4f57e463-f4d5-4255-83d4-806b0cabaac5
modified: 1564440756
request_type: enrollment_snapshot
result: {}
status: processing
transactions:
- a6e30204-87b2-4802-95a4-a156bd0f7435
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create an Enrollment Snapshot Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/new_hire:
x-summary: New Hire Enrollment Member Request
post:
description: The new hire member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers.
operationId: newHireEnrollmentMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
summary: A New Hire Enrollment request with employee and dependents enrolling
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
created: 1557512389
lines_of_coverage:
dental:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: ff033377-59e2-40df-8206-8cec3a725411
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: ff033377-59e2-40df-8206-8cec3a725411
vision:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
modified: 1564440756
signature_date: '2020-01-15'
schema:
$ref: '#/components/schemas/MemberRequestNewHireEnrollmentRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
dental:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: ff033377-59e2-40df-8206-8cec3a725411
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: ff033377-59e2-40df-8206-8cec3a725411
vision:
enrolling_members:
- id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
member_type: employee
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
- id: 165d4537-be5f-4744-8a97-a5b10fcb75b1
member_type: dependent
plan_id: 08f9e430-9686-4b07-9e2c-6b26b8133dc3
signature_date: '2020-01-15'
employee_id: 72af10df-a8b3-46f1-a114-ac36d4b8a6ea
id: 4f57e463-f4d5-4255-83d4-806b0cabaac5
request_type: new_hire
result: {}
status: processing
transactions:
- a6e30204-87b2-4802-95a4-a156bd0f7435
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a New Hire Enrollment Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/open_enrollment:
x-summary: Open Enrollment Member Request
post:
description: The open enrollment member request is used to make changes to existing employees, dependents and coverages during the open enrollment period.
operationId: openEnrollmentMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
created: 1557512389
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
modified: 1564440756
signature_date: '2022-01-15'
schema:
$ref: '#/components/schemas/MemberRequestOpenEnrollmentRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
signature_date: '2022-01-15'
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: f4517b87-275a-42e1-85e5-47ea6ab5312b
request_type: open_enrollment
status: processing
transactions:
- 579952dd-9a66-4587-a4f7-72a63bf9ec86
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a Open Enrollment Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/qualifying_life_event:
x-summary: Qualifying Life Event Member Request
post:
description: The qualifying life event member request is used to make changes to existing employees, dependents and coverages due to a qualifying life event.
operationId: qualifyingLifeEventMemberRequest
parameters:
- description: The unique identifier of the employee related to the member request
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
created: 1557512389
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
modified: 1564440756
signature_date: '2020-01-15'
event:
event_date: '2020-01-01'
event_type: newborn
schema:
$ref: '#/components/schemas/MemberRequestQualifyingLifeEventRequest'
required: true
responses:
'201':
content:
application/json:
example:
body:
coverages:
- carrier_config: {}
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
lines_of_coverage:
medical:
adding_coverage:
- id: fd62665c-0846-4e9d-bd29-80779b5f685c
member_type: dependent
plan_id: b988cd26-121a-4dd6-b0be-09399f6ecc0a
signature_date: '2020-01-15'
event:
event_date: '2020-01-01'
event_type: newborn
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: f4517b87-275a-42e1-85e5-47ea6ab5312b
request_type: qualifying_life_event
status: processing
transactions:
- 579952dd-9a66-4587-a4f7-72a63bf9ec86
schema:
$ref: '#/components/schemas/MemberRequestResult'
description: Successful Response - Returns the new Member Request
summary: Create a Qualifying Life Event Member Request
tags:
- Member Requests
/api/v1/employees/{employee_id}/member_requests/termination:
x-summary: Termination Member Request
post:
description: The `termination` member request is u
# --- truncated at 32 KB (172 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/noyo/refs/heads/main/openapi/noyo-member-requests-api-openapi.yml