Noyo Member Snapshot API
The Member Snapshot API from Noyo — 9 operation(s) for member snapshot.
OpenAPI Specification
openapi: 3.0.1
info:
description: APIs to manage and consume information about Carriers
title: Noyo Carrier Carrier Mapped Field Member Snapshot API
version: 1.0.0
servers: []
tags:
- name: Member Snapshot
paths:
/api/v1/employees/{employee_id}/member_snapshot:
x-summary: Get a single employees member snapshot
get:
description: Get a Member Snapshot by Employee ID. This will be calculated based on the current state of Noyo data for the employee.
operationId: getMemberSnapshotForEmployee
parameters:
- description: The unique identifier of the employee
in: path
name: employee_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: Filter by associated status
in: query
name: status
schema:
items:
type: string
type: array
- description: Filter by ID (comma separated)
in: query
name: id
required: false
schema:
items:
format: uuid
type: string
type: array
- description: Filter by fulfillment summary carrier ID (comma separated)
in: query
name: fulfillment_summary_carrier_id
required: false
schema:
items:
format: uuid
type: string
type: array
- description: Filter by fulfillment summary status (comma separated)
in: query
name: fulfillment_summary_status
required: false
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
example:
coverages:
- carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
enrolled_members:
- effective_end_date: '9999-12-31'
effective_start_date: '2022-01-01'
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'
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'
individual_type: employee
- effective_end_date: '2021-12-31'
effective_start_date: '2022-01-01'
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'
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
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: 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
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
schema:
$ref: '#/components/schemas/InboundMemberSnapshot'
description: Successful Response - Returns the Member Snapshot contents for an employee
'404':
content:
application/json:
example:
message: Employee not found with UUID 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
status: 404
description: Failure Response - Not found error
summary: Get a Member Snapshot by Employee
tags:
- Member Snapshot
/api/v1/employees/{employee_id}/member_snapshots:
get:
description: Returns a list with metadata for all member snapshots for a given employee.
operationId: getMemberSnapshotsForEmployeeList
parameters:
- description: The unique identifier of the employee for which you would like to view member snapshots
in: path
name: employee_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
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:
- created: 1599184829
employee_id: 7f39b5e0-460d-49e2-83b7-a1b6f2726b12
fulfillment_summary:
- carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
errors: []
status: processing
id: bc4aea3e-f728-4b05-85dc-e1ea14456e83
modified: 1599184829
status: processing
version: 431b7d10-3da6-4c5e-bb2f-58a6ebb1224f
- created: 1557512389
employee_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
fulfillment_summary:
- carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
errors: []
status: sent
id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
modified: 1564440756
status: completed
version: 6260146a-3486-4c3d-b2a6-fcd3f8c84043
schema:
$ref: '#/components/schemas/OutboundPaginatedMemberSnapshot'
description: Successful Response - Returns metadata for any matching Member Snapshots
'404':
content:
application/json:
example:
message: Employee not found with UUID 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
status: 404
description: Failure Response - Not found error
summary: Get all Member Snapshots by Employee
tags:
- Member Snapshot
/api/v1/employees/{employee_id}/status:
x-summary: Get Current Employee Status compared to Snapshots
get:
description: Returns the status of the employee and family, summarized by carrier and including any pending or completed enrollment changes requested by the platform.
operationId: getEmployeeStatus
parameters:
- description: The unique identifier of the employee
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
responses:
'200':
content:
application/json:
examples:
pending_changes:
value:
carrier_statuses:
- carrier_id: 1012fbfe-3fbf-422b-807c-b449a3119a61
pending_changes:
- id: 6e0d7cf3-e8a8-42a1-b2dc-269fa988b99e
status: processing
type: member_snapshot
status: pending_changes
stable:
value:
carrier_statuses:
- carrier_id: 1012fbfe-3fbf-422b-807c-b449a3119a61
latest_platform_change:
id: 6e0d7cf3-e8a8-42a1-b2dc-269fa988b99e
status: completed
type: member_snapshot
pending_changes: []
status: stable
unable_to_fulfill:
value:
carrier_statuses:
- carrier_id: 1012fbfe-3fbf-422b-807c-b449a3119a61
latest_platform_change:
error:
message: Salary effective date needed for volume change
id: c39ccd04-b4ef-4a5f-b267-c32c83fa50fa
status: failed
type: member_snapshot
pending_changes: []
status: unable_to_fulfill
schema:
$ref: '#/components/schemas/EmployeeStatusResult'
description: Returns details about the current status of the Employee
'404':
content:
application/json:
example:
message: Employee not found with UUID 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
status: 404
description: Failure Response - Not found error
summary: Get Employee Status
tags:
- Member Snapshot
/api/v1/groups/{group_id}/member_snapshots:
x-summary: Get all member snapshots by group
get:
description: Returns a list with metadata for all member snapshots for a given group.
operationId: getMemberSnapshotsForGroupList
parameters:
- description: The unique identifier of the group for which you would like to view member snapshots
in: path
name: group_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
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
- description: The employee ID associated with the member snapshot
in: query
name: employee_id
required: false
schema:
example: a88f4b6f-7c26-4dd0-8b62-6c76f06412ad
format: uuid
type: string
- description: Filter by associated status
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Filter by ID (comma separated)
in: query
name: id
required: false
schema:
items:
format: uuid
type: string
type: array
- description: Filter by fulfillment summary carrier ID (comma separated)
in: query
name: fulfillment_summary_carrier_id
required: false
schema:
items:
format: uuid
type: string
type: array
- description: Filter by fulfillment summary status (comma separated)
in: query
name: fulfillment_summary_status
required: false
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 2
response:
- created: 1599184829
employee_id: 7f39b5e0-460d-49e2-83b7-a1b6f2726b12
fulfillment_summary:
- carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
errors: []
status: processing
id: bc4aea3e-f728-4b05-85dc-e1ea14456e83
modified: 1599184829
status: processing
version: 431b7d10-3da6-4c5e-bb2f-58a6ebb1224f
- created: 1557512389
employee_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
fulfillment_summary:
- carrier_id: 4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1
errors: []
status: sent
id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
modified: 1564440756
status: completed
version: 6260146a-3486-4c3d-b2a6-fcd3f8c84043
schema:
$ref: '#/components/schemas/OutboundPaginatedMemberSnapshot'
description: Successful Response - Returns metadata for any matching Member Snapshots
'404':
content:
application/json:
example:
message: Group not found with UUID 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
status: 404
description: Failure Response - Not found error
summary: Get all Member Snapshots by Group
tags:
- Member Snapshot
post:
description: Create a new Member Snapshot for an employee associated with a group.
operationId: createMemberSnapshot
parameters:
- description: The unique identifier of the group for the employee referenced in the snapshot
in: path
name: group_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
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
schema:
$ref: '#/components/schemas/InboundMemberSnapshot'
required: true
responses:
'201':
content:
application/json:
example:
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: []
schema:
$ref: '#/components/schemas/OutboundMemberSnapshot'
description: Successful Response - Returns the contents of the newly created Member Snapshot
'400':
content:
application/json:
example:
message: 'Error creating dependent. Existing dependent has matching name and date of birth: ab740704-7c37-4010-92b3-d22c6926be3e'
status: 400
description: Failure Response - Client error
'404':
content:
application/json:
example:
message: Dependent with ID ab740704-7c37-4010-92b3-d22c6926be3e does not have an associated employee.
status: 404
description: Failure Response - Not found error
'422':
content:
application/json:
example:
message: 'This snapshot is missing the following active coverages: dental for dependent ab740704-7c37-4010-92b3-d22c6926be3e. If you intend to terminate a coverage, please send a snapshot that includes a termination date before omitting it from future snapshots.'
status: 422
description: Failure Response - Schema validation error
summary: Create a Member Snapshot
tags:
- Member Snapshot
/api/v1/groups/{group_id}/member_snapshots/test:
x-summary: Public endpoint for testing creation of a member snapshot
post:
description: Test creating a Member Snapshot for an employee associated with a group
operationId: testCreateMemberSnapshot
parameters:
- description: The unique identifier of the group for the employee referenced in the snapshot
in: path
name: group_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
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_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'
# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/noyo/refs/heads/main/openapi/noyo-member-snapshot-api-openapi.yml