NAV Navbar
cURL

Noyo Group Benefits API

Scroll down for code samples, example requests and responses.

The Noyo group benefits API enables benefits administration platforms to seamlessly manage group benefits policies with many insurance carriers simultaneously. Noyo automates administration across the entire policy lifecycle, from initial group installation through setup, ongoing eligibility management, and renewal.

Get started by installing or connecting a group:

Installation is for groups that do not have existing coverage with a carrier. You’ll use Noyo’s endpoints to fill out an application, submit relevant documents, and track whether the carrier has installed the group in their system.

Connecting a group is necessary for groups that already exist at the carrier. Once a group is successfully connected, you can begin sending policy management requests through Noyo.

Notes

In the field lists in this document, * designates that field is required

All datetimes can be assumed to be represented in UTC timezone, unless otherwise noted. Datetimes expressed as an integer value are relative to the Unix epoch.

How Noyo’s API is unique

You may notice that many service endpoints do not support methods to directly create or update particular objects (member transactions, individual enrollments, groups, etc.). Instead of this approach, Noyo provides interfaces that allow you to request that actions be taken, such as a member request or a group connection. These requests are routed through Noyo’s enrollment rules and the carrier system, which can in turn create or update read-only objects. This separation between requests and results ensures that requested actions are routed through the appropriate channels and result in the appropriate action; it also allows you to discover the status of a given request.

Authentication

Code Sample

curl -X POST
 --header "Content-Type: application/json"
 --header "Authorization: Basic <Base64Encode(<CLIENT_ID>:<CLIENT_SECRET>)>"
 --data '{"grant_type": "client_credentials"}'
 https://accounts.noyo.com/auth/public/token

Example Response

{
  "access_token": "<ACCESS_TOKEN>",
  "expires_in": 864000,
  "token_type": "Bearer"
}

Each customer account has a unique pair of API credentials. Contact Noyo support to receive an CLIENT_ID, CLIENT_SECRET pair as part the initial onboarding.

Getting a Token

In order to make API calls to Noyo's API you just generate a temporary access token (valid for 10 minutes) by calling https://accounts.noyo.com/auth/public/token using your CLIENT_ID and CLIENT_SECRET as the username/password combination in a Basic Authentication header.

Calling the API

After generating the token using the instructions above, include the ACCESS_TOKEN in the Authorization header for each request: Authorization: Bearer <ACCESS_TOKEN>.

Sandbox

Noyo provides a sandbox environment for the Fulfillment API to aid the development process. The API of the sandbox is identical to that of the live Fulfillment API. However, it does not carry out your Member Requests in the carrier's system. This will allow you to develop and test your Noyo integration before going live. You can use your sandbox API credentials to generate an access token from https://accounts.noyo.com/auth/public/token. Just follow the instructions above!

After you have generated your access token you can access the sandbox API by hitting:

https://fulfillment-sandbox.noyo.com

Pagination

Code Sample

curl -X GET
 --header "Content-Type: application/json"
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups?page_size=5&offset=5

Example Response

{
    "meta": {
        "offset": 5,
        "page_num": 2,
        "page_size": 5,
        "total_records": 60
    },
    "response": [
        {
            "id": "049c6ac3-3cf2-4d99-b781-aaa9aa846cb2",
            "version": "0dce45a0-089c-470a-a15b-58080159d407",
            "created": 1557862286,
            "modified": 1557862286,
            "organization_id": "bb728722-18b8-4b9b-8613-45bedb6040d4",
            "name": "Company 1",
            "sic_code": "2121"
            },
        {
            "id": "06108fa4-ce4e-47d9-bb2f-8aec0553f9e5",
            "version": "0e418c78-a9df-4fd5-9d32-639015eff637",
            "created": 1558451441,
            "modified": 1558451441,
            "organization_id": "bb728722-18b8-4b9b-8613-45bedb6040d4",
            "name": "Company 2",
            "sic_code": "2121"
            },
        {
            "id": "0bbb8ebb-26a8-4724-99d3-5c76c198be0a",
            "version": "84f253a4-ce07-4601-ac13-75b410c4a94b",
            "created": 1557862304,
            "modified": 1557862304,
            "organization_id": "bb728722-18b8-4b9b-8613-45bedb6040d4",
            "name": "Company 3",
            "sic_code": "2121"
            },
        {
            "id": "0dc7c14f-4184-4a35-ab67-ff127bfd7bc9",
            "version": "ff9d3603-45a0-46f2-b035-96fa777255b3",
            "created": 1557868278,
            "modified": 1557868278,
            "organization_id": "bb728722-18b8-4b9b-8613-45bedb6040d4",
            "name": "Company 4",
            "sic_code": "2121"
            },
        {
            "id": "12a2f910-8959-4076-9907-2050945da309",
            "version": "db3cf8d5-185a-49ff-80e3-ee3afe56f935",
            "created": 1557329939,
            "modified": 1557329939,
            "organization_id": "bb728722-18b8-4b9b-8613-45bedb6040d4",
            "name": "Company 5",
            "sic_code": "2121"
        }
    ]
}

All resources that support bulk fetching a "list" of objects share a common structure and take the optional arguments page_size and offset.

Query Parameters

page_size Number of records returned in the list, defaults to 20, must be at least 5, cannot exceed 100
offset The entry in the list at which to begin returning results, defaults to 0

Paginated Result

meta
  • offset: Value passed in via the query parameters
  • page_num: Current page number, computed using total_records and page_size
  • page_size: Value passed in via the query parameters
  • total_records: Total number of records available in the API
response Array of records in the list, structure will vary by endpoint.

Changes Over Time

Several of the Noyo models track data elements that change over time. For example, a group plan may only be available for one enrollment year but then it could be discontinued, or a member might enroll in the same life plan for multiple years but their coverage volume could change after each open enrollment period.

The Noyo API endpoints allow callers to query for these models with an optional target effective_date. This will allow you to easily answer questions like "What was the status of this user's enrollment one month ago?" or "What volume of coverage did the member elect last year?". The group carrier configuration, group enrollment, group plan, and individual enrollment models all support this behavior.

The API will return our best approximation of the status of a record as-of the requested effective_date, given that we may not be able to reconstruct the complete history of a record for all carriers. The default behavior when no effective_date is provided is to return the state of the record as-of today.

Example: Individual Enrollments

Suppose you sent Noyo a member request to enroll an employee in coverage and their individual enrollment was created with an effective_start_date for coverage on 7/1/2020.

Querying with an effective_date prior to the effective_start_date

Code Sample

curl -X GET
 --header "Content-Type: application/json"
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/individual_enrollments/ac96373c-fcb2-4cb5-af1f-52d2afeace01?effective_date=2020-06-15

Example Response

{
    "id": "ac96373c-fcb2-4cb5-af1f-52d2afeace01",
    "version": "fe8c33aa-2721-4097-9695-63512f8ac90a",
    "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384",
    "line_of_coverage": "medical",
    "status": "pending",
    "individual_type": "employee",
    "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a",
    "enroll_data": {},
    "effective_start_date": "2020-07-01",
    "effective_end_date": "2021-07-01",
    "individual_enrollment_configuration": {},
    "created": 1592141191,
    "modified": 1592141191
}

With an effective_date prior to the resource's effective_start_date, the individual enrollment in the response should have a pending status. It's also possible that no record will be returned if Noyo did not have any record of this enrollment prior to the effective_start_date, as may be the case in a broker of record change.























Querying with an effective_date after the effective_start_date

Code Sample

curl -X GET
 --header "Content-Type: application/json"
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/individual_enrollments/ac96373c-fcb2-4cb5-af1f-52d2afeace01?effective_date=2020-07-15

Example Response

{
    "id": "ac96373c-fcb2-4cb5-af1f-52d2afeace01",
    "version": "fe8c33aa-2721-4097-9695-63512f8ac90a",
    "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384",
    "line_of_coverage": "medical",
    "status": "active",
    "individual_type": "employee",
    "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a",
    "enroll_data": {},
    "effective_start_date": "2020-07-01",
    "effective_end_date": "2021-07-01",
    "individual_enrollment_configuration": {},
    "created": 1592141191,
    "modified": 1592141191
}

After the member request is completed and the member is confirmed active on coverage, querying for the individual enrollment with an effective_date after the resource's effective_start_date should return a status of active. As long as we have not received a termination or a QLE request to remove this coverage, you will find that the response returns an active status even for dates far in the future.

























Querying with an effective_date after the effective_end_date

Code Sample

curl -X GET
 --header "Content-Type: application/json"
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/individual_enrollments/ac96373c-fcb2-4cb5-af1f-52d2afeace01?effective_date=2020-11-01

Example Response

{
    "id": "ac96373c-fcb2-4cb5-af1f-52d2afeace01",
    "version": "fe8c33aa-2721-4097-9695-63512f8ac90a",
    "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384",
    "line_of_coverage": "medical",
    "status": "terminated",
    "individual_type": "employee",
    "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a",
    "enroll_data": {},
    "effective_start_date": "2020-07-01",
    "effective_end_date": "2020-09-30",
    "individual_enrollment_configuration": {},
    "created": 1592141191,
    "modified": 1592181928
}

Suppose you later send Noyo a termination member request for this employee and their individual enrollment is updated with a coverage effective_end_date of 9/30/2020.

After the member request is completed and the member coverage is confirmed to be terminated on 9/30/2020, querying for the individual enrollment with an effective_date after the resource's effective_end_date should return a status of terminated.

Integration Guide

Group Installation Flow

The following diagram illustrates the typical flow of creating an application for a group and sending it to one or more carriers:

Noyo New Group Installation Flow

Mapping for Enrollment Management

The Noyo API is able to provide a level of correctness and visibility by working based off unique identifiers for things like Plans, Employees, and Dependents. This ensures that requests coming in from the API can go through extensive validation to ensure the correct actions are taken with each carrier. From an integration standpoint this requires some amount of mapping between the entities in the Noyo system and the entities in your system. This guide serves as a blueprint for how you can go about that mapping process and then proceed to making ongoing requests to the API.

Two Mapping Flows

There are two types of mapping flows with the Noyo API depending on whether the group has existing coverage with the insurance carrier or is getting enrolled for the very first time with that carrier.

Existing Group Setup

In this case the Noyo API is populated with information about the group's plans, employees, dependents and enrollments already (pulled directly from the carrier system). You are responsible for mapping these entities and their unique IDs to the corresponding entities in your system.

You should create a function / routine / process / etc. that for a given group can perform the following operations:

Noyo Existing Group Setup Flow

New Group Setup

The Noyo API is populated with information about the group's plans, but you are responsible for creating employees and dependents and instructing what plans they should be enrolled in.

You should create a function / routine / process / etc. that for a given group can perform the following operations:

Noyo New Group Setup Flow

Mapping Groups

You can query a list of all groups in the API using the Get Groups endpoint. Remember you can use the pagination query parameters to go through more groups at one time. You should be able to match up the group using the following fields:

Field Description
name Always present
dba_name Optional, Doing Business As name

Alternatively, in order to identify a group by a carrier-specific ID, use the group list endpoint and query using a carrier_id and carrier_group_id combination. This may be a helpful mapping if these are IDs you store. See our carrier specs for what carrier-specific ID is used for each carrier.

Mapping Employees

You can query a list of all employees within a group using the Filtering Employees in a Group endpoint. You can optionally specify filters in the query parameters for first_name, last_name, and date_of_birth. You should be able to match up the employee using the following fields:

Field Description
person.first_name Always present, make sure to map agnostic of letter casing
person.last_name Always present, make sure to map agnostic of letter casing
person.date_of_birth Always present, always in the format YYYY-MM-DD
person.ssn Optional, not all carriers store this in their system

Mapping Dependents

Once you have mapped the employee you can query the dependents that belong to that employee with the Get Dependents endpoint. You should be able to match up the dependents using the following fields:

Field Description
person.first_name Always present, make sure to map agnostic of letter casing
person.last_name Always present, make sure to map agnostic of letter casing
person.date_of_birth Always present, always in the format YYYY-MM-DD
person.ssn Optional, not all carriers store this in their system
relationship Always present

Mapping Plans

Map a group's plans using the group plans endpoint. Plans can be matched by some combination of line of coverage, name, and other attributes included in the API response. The API will return plans associated with a group enrollment for its carrier and effective dates. Group enrollment data should also be mapped to your data, especially so that correct open enrollment dates can be recorded. A common hierarchy of group enrollments and group plans looks like this:

Common Group Enrollment Hierarchy

Enrolling During New Group Setup

During the New Group Setup process, the Employees and Dependents will not yet exist and it will be your responsibility to create them using the Create Employee and Create Dependent endpoints. After you make the create requests you should save the IDs of the created employees and dependents into your system.

After you have created these you can send an Open Enrollment Member Request for each employee which includes information about what plan(s) the employee and their dependents would like to enroll in.

Ongoing Member Requests

After the mapping process completes for each a group (either through the existing or new group setup flow) you will be able to start making ongoing Member Requests to the API. This should be very straightforward after the mapping process is completed because the payloads consist largely of IDs and the validation will prevent you from sending incorrect or incomplete data to the API. More details on creating API calls for each Member Request can be found here:

Group Installation

In our group installation service, we will support the initial application flow (creating and configuring a group, creating employees and dependents, adding lines of coverage, and plans) document management, (sending the list of required documents and associating the completed documents with the application), and application submission and confirmation.

Note: Groups successfully installed at the carrier through Noyo’s API are automatically available for enrollment management; no additional connection is needed.

Groups

Getting all groups

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "business_details": {
                "company_description": "Metal mining for the common person",
                "date_established": "2020-01-01",
                "employer_type": "private_sector",
                "entity_type": "s_corp"
            },
            "created": 1628617987,
            "federal_ein": "98-7654321",
            "group_name": "Metgenics",
            "id": "97c1bce3-0dde-4823-bea5-4f3f3af1d4ed",
            "insurance_details": {
                "is_erisa_compliant": false,
                "is_erisa_subject": false
            },
            "modified": 1628617987,
            "organization_id": "76448284-fef2-43b3-a1ba-adac62bea52c",
            "sic_code": "1000",
            "version": "44b130ee-3b71-4ab3-8b02-94d1aca55922"
        }
    ]
}

Returns a list of all groups

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get all groups response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • business_details:
    • company_description: General description of the type of business
    • date_established: Date the company was established
    • employer_type: Type or classification of the group as an employer. One of: foreign_government, private_sector, religious_employer, state_government, tribal_government
    • entity_type: Type of legal or business entity. One of: c_corp, llc, llp, partnership, s_corp
  • created*: The date the record was created
  • dba_name: DBA name for the company, if applicable
  • federal_ein: Federal Employer Identification Number for the group/company
  • group_name*: Name of the group/company
  • id*: Unique identifier of the record in Noyo
  • insurance_details:
    • is_erisa_compliant: True if the group is compliant with ERISA regulation
    • is_erisa_subject: True if company is subject to ERISA regulation
  • modified*: The date the record was last updated
  • organization_id*: Unique identifier of the platform or broker organization in the Noyo system
  • sic_code: SIC Code for the group/company
  • version*: Current version of the record

Getting a single group

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/97c1bce3-0dde-4823-bea5-4f3f3af1d4ed

Example Response

{
    "business_details": {
        "company_description": "Metal mining for the common person",
        "date_established": "2020-01-01",
        "employer_type": "private_sector",
        "entity_type": "s_corp"
    },
    "created": 1628617987,
    "federal_ein": "98-7654321",
    "group_name": "Metgenics",
    "id": "97c1bce3-0dde-4823-bea5-4f3f3af1d4ed",
    "insurance_details": {
        "is_erisa_compliant": false,
        "is_erisa_subject": false
    },
    "modified": 1628617987,
    "organization_id": "76448284-fef2-43b3-a1ba-adac62bea52c",
    "sic_code": "1000",
    "version": "44b130ee-3b71-4ab3-8b02-94d1aca55922"
}

Returns the latest version of a single group based on the ID provided.

Path Parameters

group_id The unique identifier of the group in Noyo

Get a single group response

business_details object
  • company_description: General description of the type of business
  • date_established: Date the company was established
  • employer_type: Type or classification of the group as an employer. One of: foreign_government, private_sector, religious_employer, state_government, tribal_government
  • entity_type: Type of legal or business entity. One of: c_corp, llc, llp, partnership, s_corp
created* timestamp The date the record was created
dba_name string DBA name for the company, if applicable
federal_ein string Federal Employer Identification Number for the group/company
group_name* string Name of the group/company
id* uuid Unique identifier of the record in Noyo
insurance_details object
  • is_erisa_compliant: True if the group is compliant with ERISA regulation
  • is_erisa_subject: True if company is subject to ERISA regulation
modified* timestamp The date the record was last updated
organization_id* uuid Unique identifier of the platform or broker organization in the Noyo system
sic_code string SIC Code for the group/company
version* uuid Current version of the record

Create a group

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups

Body Parameter


{
    "business_details": {
        "company_description": "Metal mining for the common person",
        "date_established": "2020-01-01",
        "employer_type": "private_sector",
        "entity_type": "s_corp"
    },
    "federal_ein": "98-7654321",
    "group_name": "Metgenics",
    "insurance_details": {
        "is_erisa_compliant": false,
        "is_erisa_subject": false
    },
    "sic_code": "1000"
}

Example Response

{
    "business_details": {
        "company_description": "Metal mining for the common person",
        "date_established": "2020-01-01",
        "employer_type": "private_sector",
        "entity_type": "s_corp"
    },
    "created": 1628617987,
    "federal_ein": "98-7654321",
    "group_name": "Metgenics",
    "id": "97c1bce3-0dde-4823-bea5-4f3f3af1d4ed",
    "insurance_details": {
        "is_erisa_compliant": false,
        "is_erisa_subject": false
    },
    "modified": 1628617987,
    "organization_id": "76448284-fef2-43b3-a1ba-adac62bea52c",
    "sic_code": "1000",
    "version": "44b130ee-3b71-4ab3-8b02-94d1aca55922"
}

In this step you’ll pass basic information about the group, such as their name, SIC code, and EIN. You can then move on to further configure the group, associate this group with one or more applications, and add employees and dependents to that group.

Request Body

business_details object
  • company_description: General description of the type of business
  • date_established: Date the company was established
  • employer_type: Type or classification of the group as an employer. One of: foreign_government, private_sector, religious_employer, state_government, tribal_government
  • entity_type: Type of legal or business entity. One of: c_corp, llc, llp, partnership, s_corp
dba_name string DBA name for the company, if applicable
federal_ein string Federal Employer Identification Number for the group/company
group_name* string Name of the group/company
insurance_details object
  • is_erisa_compliant: True if the group is compliant with ERISA regulation
  • is_erisa_subject: True if company is subject to ERISA regulation
organization_id uuid Unique identifier of the platform or broker organization in the Noyo system
sic_code string SIC Code for the group/company

Create Group Response

business_details object
  • company_description: General description of the type of business
  • date_established: Date the company was established
  • employer_type: Type or classification of the group as an employer. One of: foreign_government, private_sector, religious_employer, state_government, tribal_government
  • entity_type: Type of legal or business entity. One of: c_corp, llc, llp, partnership, s_corp
created* timestamp The date the record was created
dba_name string DBA name for the company, if applicable
federal_ein string Federal Employer Identification Number for the group/company
group_name* string Name of the group/company
id* uuid Unique identifier of the record in Noyo
insurance_details object
  • is_erisa_compliant: True if the group is compliant with ERISA regulation
  • is_erisa_subject: True if company is subject to ERISA regulation
modified* timestamp The date the record was last updated
organization_id* uuid Unique identifier of the platform or broker organization in the Noyo system
sic_code string SIC Code for the group/company
version* uuid Current version of the record

Edit a group

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/8a4b1f15-d4d8-4139-8c3f-8aeb6050841e

Body Parameter


{
    "group_name": "Metvio"
}

Example Response

{
    "business_details": {
        "company_description": "Metal mining for the common person",
        "date_established": "2020-01-01",
        "employer_type": "private_sector",
        "entity_type": "s_corp"
    },
    "created": 1628617987,
    "federal_ein": "98-7654321",
    "group_name": "Metvio",
    "id": "97c1bce3-0dde-4823-bea5-4f3f3af1d4ed",
    "insurance_details": {
        "is_erisa_compliant": false,
        "is_erisa_subject": false
    },
    "modified": 1628617990,
    "organization_id": "76448284-fef2-43b3-a1ba-adac62bea52c",
    "sic_code": "1000",
    "version": "2f105731-7057-4aa8-a073-ccbb4ed6d8d3"
}

Edit a group based on the ID provided. The version parameter must match the latest group version.

Path Parameters

group_id The unique identifier of the group in Noyo
version The current version identifier of the group

Request Body

business_details object
  • company_description: General description of the type of business
  • date_established: Date the company was established
  • employer_type: Type or classification of the group as an employer. One of: foreign_government, private_sector, religious_employer, state_government, tribal_government
  • entity_type: Type of legal or business entity. One of: c_corp, llc, llp, partnership, s_corp
dba_name string DBA name for the company, if applicable
federal_ein string Federal Employer Identification Number for the group/company
group_name string Name of the group/company
insurance_details object
  • is_erisa_compliant: True if the group is compliant with ERISA regulation
  • is_erisa_subject: True if company is subject to ERISA regulation
sic_code string SIC Code for the group/company

Edit Group Response

business_details object
  • company_description: General description of the type of business
  • date_established: Date the company was established
  • employer_type: Type or classification of the group as an employer. One of: foreign_government, private_sector, religious_employer, state_government, tribal_government
  • entity_type: Type of legal or business entity. One of: c_corp, llc, llp, partnership, s_corp
created* timestamp The date the record was created
dba_name string DBA name for the company, if applicable
federal_ein string Federal Employer Identification Number for the group/company
group_name* string Name of the group/company
id* uuid Unique identifier of the record in Noyo
insurance_details object
  • is_erisa_compliant: True if the group is compliant with ERISA regulation
  • is_erisa_subject: True if company is subject to ERISA regulation
modified* timestamp The date the record was last updated
organization_id* uuid Unique identifier of the platform or broker organization in the Noyo system
sic_code string SIC Code for the group/company
version* uuid Current version of the record

Contacts

Get all group contacts

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/contacts

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "created": 1628617987,
            "email": "joanee@company.com",
            "first_name": "Joanee",
            "group_id": "40ed8d7f-3698-4d04-9b28-b2fb3532f5d7",
            "id": "e013e4b9-a2e0-4934-8d3c-fab67d9aa03f",
            "last_name": "Schmidt",
            "modified": 1628617987,
            "phone_number": "5554443322",
            "primary_contact": true,
            "title": "CFO",
            "types": [
                "billing",
                "executive"
            ],
            "version": "8bfd86e8-dee2-4e96-b1a5-3dc8745fd7cf"
        }
    ]
}

Returns a list of all contacts for a given group

Path Parameters

group_id The unique identifier of the group for which you would like to view contacts

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get all contacts response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • created*: The date the record was created
  • email*: Work email address of the group contact
  • first_name: First name of the group contact
  • group_id*: Unique identifier of the group in Noyo
  • id*: Unique identifier of the record in Noyo
  • last_name: Last name of the group contact
  • modified*: The date the record was last updated
  • phone_number*: Work phone number of the group contact in E.164 format
  • primary_contact*: True if contact is the primary contact for the group
  • title*: Job title of the group contact
  • types*: List of contact types for the group contact. One or more of: billing, company, executive, online
  • version*: Current version of the record

Get a single group contact

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/40ed8d7f-3698-4d04-9b28-b2fb3532f5d7/contacts/e013e4b9-a2e0-4934-8d3c-fab67d9aa03f

Example Response

{
    "created": 1628617987,
    "email": "joanee@company.com",
    "first_name": "Joanee",
    "group_id": "40ed8d7f-3698-4d04-9b28-b2fb3532f5d7",
    "id": "e013e4b9-a2e0-4934-8d3c-fab67d9aa03f",
    "last_name": "Schmidt",
    "modified": 1628617987,
    "phone_number": "5554443322",
    "primary_contact": true,
    "title": "CFO",
    "types": [
        "billing",
        "executive"
    ],
    "version": "8bfd86e8-dee2-4e96-b1a5-3dc8745fd7cf"
}

Returns the latest version of a single contact based on the ID provided.

Path Parameters

group_id The unique identifier of the group in Noyo
contact_id The unique identifier of the contact in Noyo

Get a single group contact response

created* timestamp The date the record was created
email* string Work email address of the group contact
first_name string First name of the group contact
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
last_name string Last name of the group contact
modified* timestamp The date the record was last updated
phone_number* string Work phone number of the group contact in E.164 format
primary_contact* boolean True if contact is the primary contact for the group
title* string Job title of the group contact
types* array List of contact types for the group contact. One of: billing, company, executive, online
version* uuid Current version of the record

Create a contact

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/40ed8d7f-3698-4d04-9b28-b2fb3532f5d7/contacts

Body Parameter


{
    "email": "joanee@company.com",
    "first_name": "Joanee",
    "last_name": "Schmidt",
    "phone_number": "5554443322",
    "primary_contact": true,
    "title": "CFO",
    "types": [
        "billing",
        "executive"
    ]
}

Example Response

{
    "created": 1628617987,
    "email": "joanee@company.com",
    "first_name": "Joanee",
    "group_id": "40ed8d7f-3698-4d04-9b28-b2fb3532f5d7",
    "id": "e013e4b9-a2e0-4934-8d3c-fab67d9aa03f",
    "last_name": "Schmidt",
    "modified": 1628617987,
    "phone_number": "5554443322",
    "primary_contact": true,
    "title": "CFO",
    "types": [
        "billing",
        "executive"
    ],
    "version": "8bfd86e8-dee2-4e96-b1a5-3dc8745fd7cf"
}

Create a new contact for a group

Path Parameters

group_id The unique identifier of the group in Noyo

Request Body

email* string Work email address of the group contact
first_name* string First name of the group contact
last_name* string Last name of the group contact
phone_number string Work phone number of the group contact in E.164 format
primary_contact boolean True if contact is the primary contact for the group
title string Job title of the group contact
types* array List of contact types for the group contact. One of: billing, company, executive, online

Create Contact Response

created* timestamp The date the record was created
email* string Work email address of the group contact
first_name string First name of the group contact
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
last_name string Last name of the group contact
modified* timestamp The date the record was last updated
phone_number* string Work phone number of the group contact in E.164 format
primary_contact* boolean True if contact is the primary contact for the group
title* string Job title of the group contact
types* array List of contact types for the group contact. One of: billing, company, executive, online
version* uuid Current version of the record

Edit a contact

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/contacts/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/4632c3f7-b120-4a37-9b10-5911098d40ee

Body Parameter


{
    "phone_number": "+15555551212"
}

Example Response

{
    "created": 1628617987,
    "email": "joanee@company.com",
    "first_name": "Joanee",
    "group_id": "40ed8d7f-3698-4d04-9b28-b2fb3532f5d7",
    "id": "e013e4b9-a2e0-4934-8d3c-fab67d9aa03f",
    "last_name": "Schmidt",
    "modified": 1628617990,
    "phone_number": "+15555551212",
    "primary_contact": true,
    "title": "CFO",
    "types": [
        "billing",
        "executive"
    ],
    "version": "dbc86ab1-f731-4aee-97e8-857c7a19107a"
}

Edit and existing contact for a group

Path Parameters

group_id The unique identifier of the group in Noyo
contact_id The unique identifier of the contact in Noyo
version The current version identifier of the contact

Request Body

email string Work email address of the group contact
first_name string First name of the group contact
last_name string Last name of the group contact
phone_number string Work phone number of the group contact in E.164 format
primary_contact boolean True if contact is the primary contact for the group
title string Job title of the group contact
types array List of contact types for the group contact. One of: billing, company, executive, online

Edit Contact Response

created* timestamp The date the record was created
email* string Work email address of the group contact
first_name string First name of the group contact
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
last_name string Last name of the group contact
modified* timestamp The date the record was last updated
phone_number* string Work phone number of the group contact in E.164 format
primary_contact* boolean True if contact is the primary contact for the group
title* string Job title of the group contact
types* array List of contact types for the group contact. One of: billing, company, executive, online
version* uuid Current version of the record

Locations

Get all group locations

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/locations

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "address": {
                "city": "San Francisco",
                "county": "San Francisco",
                "state": "CA",
                "street_one": "1234 Test Ln",
                "zip_code": "94107"
            },
            "created": 1628617987,
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
            "modified": 1628617987,
            "primary_location": true,
            "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7"
        }
    ]
}

Returns a list of all locations for a given group

Path Parameters

group_id The unique identifier of the group in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get all locations response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • address*:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • created*: The date the record was created
  • display_name*: Display name for the group location
  • group_id*: Unique identifier of the group in Noyo
  • id*: Unique identifier of the record in Noyo
  • modified*: The date the record was last updated
  • primary_location*: Boolean field to determine whether the group location should be used as the primary group location
  • version*: Current version of the record

Get a single location contact

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/locations/bd957820-4652-4ee7-8a3a-6413df21e28d

Example Response

{
    "address": {
        "city": "San Francisco",
        "county": "San Francisco",
        "state": "CA",
        "street_one": "1234 Test Ln",
        "zip_code": "94107"
    },
    "created": 1628617987,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "modified": 1628617987,
    "primary_location": true,
    "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7"
}

Returns the latest version of a single location based on the ID provided.

Path Parameters

group_id The unique identifier of the group in Noyo
location_id The unique identifier of the location in Noyo

Get a single group location response

address* object
  • city*: City of the address
  • county: County of the address
  • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
  • street_one*: Line one of the address
  • street_two: Line two of the address
  • zip_code*: Zip code of the address
created* timestamp The date the record was created
display_name* string Display name for the group location
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
primary_location* boolean Boolean field to determine whether the group location should be used as the primary group location
version* uuid Current version of the record

Create a location

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/locations

Body Parameter


{
    "address": {
        "city": "San Francisco",
        "county": "San Francisco",
        "state": "CA",
        "street_one": "1234 Test Ln",
        "zip_code": "94107"
    },
    "primary_location": true
}

Example Response

{
    "address": {
        "city": "San Francisco",
        "county": "San Francisco",
        "state": "CA",
        "street_one": "1234 Test Ln",
        "zip_code": "94107"
    },
    "created": 1628617987,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "modified": 1628617987,
    "primary_location": true,
    "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7"
}

Create a new location for a group

Path Parameters

group_id The unique identifier of the group in Noyo

Request Body

address* object
  • city*: City of the address
  • county: County of the address
  • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
  • street_one*: Line one of the address
  • street_two: Line two of the address
  • zip_code*: Zip code of the address
display_name* string Display name for the group location
primary_location* boolean Boolean field to determine whether the group location should be used as the primary group location

Create Location Response

address* object
  • city*: City of the address
  • county: County of the address
  • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
  • street_one*: Line one of the address
  • street_two: Line two of the address
  • zip_code*: Zip code of the address
created* timestamp The date the record was created
display_name* string Display name for the group location
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
primary_location* boolean Boolean field to determine whether the group location should be used as the primary group location
version* uuid Current version of the record

Edit a location

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/locations/bd957820-4652-4ee7-8a3a-6413df21e28d/f4142cba-f3eb-4917-b3bd-123d683f18d7

Body Parameter


{
    "primary_location": false
}

Example Response

{
    "address": {
        "city": "San Francisco",
        "county": "San Francisco",
        "state": "CA",
        "street_one": "2345 Test St",
        "zip_code": "94109"
    },
    "created": 1628617987,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "modified": 1628617990,
    "primary_location": false,
    "version": "e3ac9313-12b6-44e1-8094-aa113501e0a8"
}

Edit a location based on the ID provided. The version parameter must match the latest location version.

Path Parameters

group_id The unique identifier of the group in Noyo
location_id The unique identifier of the location in Noyo
version The current version identifier of the location

Request Body

address object
  • city*: City of the address
  • county: County of the address
  • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
  • street_one*: Line one of the address
  • street_two: Line two of the address
  • zip_code*: Zip code of the address
display_name string Display name for the group location
primary_location boolean Boolean field to determine whether the group location should be used as the primary group location

Edit Location Response

address* object
  • city*: City of the address
  • county: County of the address
  • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
  • street_one*: Line one of the address
  • street_two: Line two of the address
  • zip_code*: Zip code of the address
created* timestamp The date the record was created
display_name* string Display name for the group location
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
primary_location* boolean Boolean field to determine whether the group location should be used as the primary group location
version* uuid Current version of the record

Group Applications

Get all group applications

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/applications

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "application_type": "new",
            "carrier_id": "7368753c-5fdb-4cad-b70b-e97c48731f06",
            "created": 1628693051,
            "group_id": "99b18a62-29f1-4586-85e8-de9dfb28987c",
            "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "modified": 1628693051,
            "notes": "",
            "status": "in_progress",
            "status_notes": "",
            "version": "fb4e01c4-e054-4bd4-9948-f464a1931a00"
        }
    ]
}

Returns a list of all applications for the given group

Path Parameters

group_id The unique identifier of the group in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get all group applications response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • application_type*: Type of application for the group with this carrier. One of: new, renewal, upsell
  • carrier_group_id*: An id given by the carrier to identify the group. e.g. policy_number, group_number or customer_id
  • carrier_id*: Unique identifier of the associated carrier in Noyo
  • created*: The date the record was created
  • group_id*: Unique identifier of the associated group in Noyo
  • id*: Unique identifier of the record in Noyo
  • modified*: The date the record was last updated
  • notes*: General platform notes about the group application
  • status*: Status of the application for the group. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
  • status_notes*: Additional notes about the application status with the carrier
  • version*: Current version of the record

Get a single group application

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9

Example Response

{
    "application_type": "new",
    "carrier_id": "7368753c-5fdb-4cad-b70b-e97c48731f06",
    "created": 1628693051,
    "group_id": "99b18a62-29f1-4586-85e8-de9dfb28987c",
    "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "modified": 1628693051,
    "notes": "",
    "status": "in_progress",
    "status_notes": "",
    "version": "fb4e01c4-e054-4bd4-9948-f464a1931a00"
}

Returns the latest version of a single group application based on the ID provided.

Path Parameters

application_id The unique identifier of the application in Noyo

Get a single group application response

application_type* string Type of application for the group with this carrier. One of: new, renewal, upsell
carrier_group_id* string An id given by the carrier to identify the group. e.g. policy_number, group_number or customer_id
carrier_id* uuid Unique identifier of the associated carrier in Noyo
created* timestamp The date the record was created
group_id* uuid Unique identifier of the associated group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
notes* string General platform notes about the group application
status* string Status of the application for the group. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
status_notes* string Additional notes about the application status with the carrier
version* uuid Current version of the record

Create a blank application

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/applications

Body Parameter


{
    "application_type": "new",
    "carrier_group_id": "US00099",
    "carrier_id": "0b220d37-2057-465c-99af-b5cb10f4d172",
    "notes": ""
}

Example Response

{
    "application_type": "new",
    "carrier_id": "0b220d37-2057-465c-99af-b5cb10f4d172",
    "created": 1628617987,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "ba1d1878-1d24-48f0-9ec0-ef7d2a603abf",
    "modified": 1628617987,
    "notes": "",
    "status": "in_progress",
    "status_notes": "",
    "version": "44f71d9f-9c6b-49d0-b2b2-2662334e3e16"
}

After creating a group, you can then create one or more new applications (one per carrier). Just pass the carrier ID and carrier group ID (if known) for the carrier associated with the application and the application type. The carrier group ID will allow us to reference the group in the carrier’s system if that has already been allocated.

Path Parameters

group_id The unique identifier of the group in Noyo

Request Body

application_type* string Type of application for the group with this carrier. One of: new, renewal, upsell
carrier_group_id string An id given by the carrier to identify the group.
carrier_id* uuid Unique identifier of the associated carrier in Noyo
notes string General platform notes about the group application

Create Group Application Response

application_type* string Type of application for the group with this carrier. One of: new, renewal, upsell
carrier_group_id* string An id given by the carrier to identify the group. e.g. policy_number, group_number or customer_id
carrier_id* uuid Unique identifier of the associated carrier in Noyo
created* timestamp The date the record was created
group_id* uuid Unique identifier of the associated group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
notes* string General platform notes about the group application
status* string Status of the application for the group. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
status_notes* string Additional notes about the application status with the carrier
version* uuid Current version of the record

Agents

Get all agents for an application

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/agents

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "agency_details": {
                "name": "James Doe",
                "national_producer_number": "5556667",
                "tax_id_number": "55-1234567"
            },
            "agent_details": {
                "first_name": "John",
                "last_name": "Doe",
                "national_producer_number": "adipisicing velit dolor",
                "tax_id_number": "55-9876543"
            },
            "commission_details": [
                {}
            ],
            "created": 1628617987,
            "general_agency_details": {
                "name": "Doe James",
                "national_producer_number": "5556667",
                "tax_id_number": "55-1234567"
            },
            "id": "969a2b7a-4ce5-42fa-812f-11b7191d9179",
            "license_number": "123456789012",
            "modified": 1628617987,
            "signature_date": "2021-01-01",
            "version": "267073b1-0be3-428d-98d9-aad87f292aef"
        }
    ]
}

Returns a list of all agents for the given application

Path Parameters

application_id The unique identifier of the application in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1.

Get all agents for an application response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • agency_details*:
    • certified: Is the agency certified
    • franchise_code: The franchise code.
    • name: The full name of the agency
    • national_producer_number: The national producer number for the agency
    • tax_id_number: The tax ID number for the agency
  • agent_details*:
    • first_name: The first name of the agent
    • last_name: The last name of the agent
    • license_number: The license number for the agent
    • national_producer_number: The national producer number for the agent
    • tax_id_number: The tax ID number for the agent
  • commission_details*:
    • commission_arrangement: Open field to describe additional special information about the commission arrangement
    • line_of_coverage: Line of coverage for which this split commission applies if any.
    • percentage_of_commission*: Percentage of commission received
  • created*: The date the record was created
  • general_agency_details*:
    • certified: Boolean for whether the general agency is certified
    • franchise_code: The franchise code of the general agency.
    • name: The full name of the general agency.
    • national_producer_number: The national producer number for the general agency.
    • tax_id_number: The tax ID number for the general agency.
  • id*: Unique identifier of the record in Noyo
  • license_number*: License number of the agent
  • modified*: The date the record was last updated
  • signature_date*: The signature date for the agent on the application
  • version*: Current version of the record

Get a single agent

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/agents/83359c7e-a14c-4381-8826-c81f026ba947

Example Response

{
    "agency_details": {
        "name": "James Doe",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "agent_details": {
        "first_name": "John",
        "last_name": "Doe",
        "national_producer_number": "adipisicing velit dolor",
        "tax_id_number": "55-9876543"
    },
    "commission_details": [
        {}
    ],
    "created": 1628617987,
    "general_agency_details": {
        "name": "Doe James",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "id": "969a2b7a-4ce5-42fa-812f-11b7191d9179",
    "license_number": "123456789012",
    "modified": 1628617987,
    "signature_date": "2021-01-01",
    "version": "267073b1-0be3-428d-98d9-aad87f292aef"
}

Returns the latest version of a single agent based on the ID provided

Path Parameters

agent_id The unique identifier of the agent in Noyo

Get a single agent response

agency_details* object
  • certified: Is the agency certified
  • franchise_code: The franchise code.
  • name: The full name of the agency
  • national_producer_number: The national producer number for the agency
  • tax_id_number: The tax ID number for the agency
agent_details* object
  • first_name: The first name of the agent
  • last_name: The last name of the agent
  • license_number: The license number for the agent
  • national_producer_number: The national producer number for the agent
  • tax_id_number: The tax ID number for the agent
commission_details* array
  • commission_arrangement: Open field to describe additional special information about the commission arrangement
  • line_of_coverage: Line of coverage for which this split commission applies if any.
  • percentage_of_commission*: Percentage of commission received
created* timestamp The date the record was created
general_agency_details* object
  • certified: Boolean for whether the general agency is certified
  • franchise_code: The franchise code of the general agency.
  • name: The full name of the general agency.
  • national_producer_number: The national producer number for the general agency.
  • tax_id_number: The tax ID number for the general agency.
id* uuid Unique identifier of the record in Noyo
license_number* string License number of the agent
modified* timestamp The date the record was last updated
signature_date* date The signature date for the agent on the application
version* uuid Current version of the record

Add agent

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/agents

Body Parameter


{
    "agency_details": {
        "name": "James Doe",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "agent_details": {
        "first_name": "John",
        "last_name": "Doe",
        "national_producer_number": "adipisicing velit dolor",
        "tax_id_number": "55-9876543"
    },
    "commission_details": [
        {}
    ],
    "general_agency_details": {
        "name": "Doe James",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "license_number": "123456789012",
    "signature_date": "2021-01-01"
}

Example Response

{
    "agency_details": {
        "name": "James Doe",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "agent_details": {
        "first_name": "John",
        "last_name": "Doe",
        "national_producer_number": "adipisicing velit dolor",
        "tax_id_number": "55-9876543"
    },
    "commission_details": [
        {}
    ],
    "created": 1628617987,
    "general_agency_details": {
        "name": "Doe James",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "id": "969a2b7a-4ce5-42fa-812f-11b7191d9179",
    "license_number": "123456789012",
    "modified": 1628617987,
    "signature_date": "2021-01-01",
    "version": "267073b1-0be3-428d-98d9-aad87f292aef"
}

Create a new agent for a group application

Path Parameters

application_id The unique identifier of the application in Noyo

Request Body

agency_details object
  • certified: Is the agency certified
  • franchise_code: The franchise code.
  • name: The full name of the agency
  • national_producer_number: The national producer number for the agency
  • tax_id_number: The tax ID number for the agency
agent_details object
  • first_name: The first name of the agent
  • last_name: The last name of the agent
  • license_number: The license number for the agent
  • national_producer_number: The national producer number for the agent
  • tax_id_number: The tax ID number for the agent
commission_details array
  • commission_arrangement: Open field to describe additional special information about the commission arrangement
  • line_of_coverage: Line of coverage for which this split commission applies if any.
  • percentage_of_commission*: Percentage of commission received
general_agency_details object
  • certified: Boolean for whether the general agency is certified
  • franchise_code: The franchise code of the general agency.
  • name: The full name of the general agency.
  • national_producer_number: The national producer number for the general agency.
  • tax_id_number: The tax ID number for the general agency.
license_number string License number of the agent
signature_date date The signature date for the agent on the application

Create Agent Response

agency_details* object
  • certified: Is the agency certified
  • franchise_code: The franchise code.
  • name: The full name of the agency
  • national_producer_number: The national producer number for the agency
  • tax_id_number: The tax ID number for the agency
agent_details* object
  • first_name: The first name of the agent
  • last_name: The last name of the agent
  • license_number: The license number for the agent
  • national_producer_number: The national producer number for the agent
  • tax_id_number: The tax ID number for the agent
commission_details* array
  • commission_arrangement: Open field to describe additional special information about the commission arrangement
  • line_of_coverage: Line of coverage for which this split commission applies if any.
  • percentage_of_commission*: Percentage of commission received
created* timestamp The date the record was created
general_agency_details* object
  • certified: Boolean for whether the general agency is certified
  • franchise_code: The franchise code of the general agency.
  • name: The full name of the general agency.
  • national_producer_number: The national producer number for the general agency.
  • tax_id_number: The tax ID number for the general agency.
id* uuid Unique identifier of the record in Noyo
license_number* string License number of the agent
modified* timestamp The date the record was last updated
signature_date* date The signature date for the agent on the application
version* uuid Current version of the record

Edit an agent

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/agents/83359c7e-a14c-4381-8826-c81f026ba947/4632c3f7-b120-4a37-9b10-5911098d40ee

Body Parameter


{
    "license_number": "123456789013"
}

Example Response

{
    "agency_details": {
        "name": "James Doe",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "agent_details": {
        "first_name": "John",
        "last_name": "Doe",
        "national_producer_number": "adipisicing velit dolor",
        "tax_id_number": "55-9876543"
    },
    "commission_details": [
        {}
    ],
    "created": 1628617987,
    "general_agency_details": {
        "name": "Doe James",
        "national_producer_number": "5556667",
        "tax_id_number": "55-1234567"
    },
    "id": "969a2b7a-4ce5-42fa-812f-11b7191d9179",
    "license_number": "123456789013",
    "modified": 1628617987,
    "signature_date": "2021-01-01",
    "version": "267073b1-0be3-428d-98d9-aad87f292aef"
}

Edit an agent based on the ID provided. The version parameter must match the latest agent version.

Path Parameters

agent_id The unique identifier of the agent in Noyo
version The current version identifier of the agent

Request Body

agency_details object
  • certified: Is the agency certified
  • franchise_code: The franchise code.
  • name: The full name of the agency
  • national_producer_number: The national producer number for the agency
  • tax_id_number: The tax ID number for the agency
agent_details object
  • first_name: The first name of the agent
  • last_name: The last name of the agent
  • license_number: The license number for the agent
  • national_producer_number: The national producer number for the agent
  • tax_id_number: The tax ID number for the agent
commission_details array
  • commission_arrangement: Open field to describe additional special information about the commission arrangement
  • line_of_coverage: Line of coverage for which this split commission applies if any.
  • percentage_of_commission*: Percentage of commission received
general_agency_details object
  • certified: Boolean for whether the general agency is certified
  • franchise_code: The franchise code of the general agency.
  • name: The full name of the general agency.
  • national_producer_number: The national producer number for the general agency.
  • tax_id_number: The tax ID number for the general agency.
license_number string License number of the agent
signature_date date The signature date for the agent on the application

Edit Agent Response

agency_details* object
  • certified: Is the agency certified
  • franchise_code: The franchise code.
  • name: The full name of the agency
  • national_producer_number: The national producer number for the agency
  • tax_id_number: The tax ID number for the agency
agent_details* object
  • first_name: The first name of the agent
  • last_name: The last name of the agent
  • license_number: The license number for the agent
  • national_producer_number: The national producer number for the agent
  • tax_id_number: The tax ID number for the agent
commission_details* array
  • commission_arrangement: Open field to describe additional special information about the commission arrangement
  • line_of_coverage: Line of coverage for which this split commission applies if any.
  • percentage_of_commission*: Percentage of commission received
created* timestamp The date the record was created
general_agency_details* object
  • certified: Boolean for whether the general agency is certified
  • franchise_code: The franchise code of the general agency.
  • name: The full name of the general agency.
  • national_producer_number: The national producer number for the general agency.
  • tax_id_number: The tax ID number for the general agency.
id* uuid Unique identifier of the record in Noyo
license_number* string License number of the agent
modified* timestamp The date the record was last updated
signature_date* date The signature date for the agent on the application
version* uuid Current version of the record

Agent Contact

Get all agent contacts

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/agents/83359c7e-a14c-4381-8826-c81f026ba947/contacts

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "agent_id": "969a2b7a-4ce5-42fa-812f-11b7191d9179",
            "created": 1628617987,
            "email": "michele.gorczany@gmail.com",
            "first_name": "Michele",
            "id": "ba1d1878-1d24-48f0-9ec0-ef7d2a603abf",
            "last_name": "Gorczany",
            "modified": 1628617987,
            "phone_number": "+15555551212",
            "title": "HR Professional",
            "types": [
                "billing"
            ],
            "version": "44f71d9f-9c6b-49d0-b2b2-2662334e3e16"
        }
    ]
}

Returns a list of all contacts for the given agent

Path Parameters

agent_id The unique identifier of the agent in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1.

Get all agent contacts response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • created*: The date the record was created
  • email*: Work email address of the group contact
  • first_name: First name of the group contact
  • group_id*: Unique identifier of the group in Noyo
  • id*: Unique identifier of the record in Noyo
  • last_name: Last name of the group contact
  • modified*: The date the record was last updated
  • phone_number*: Work phone number of the group contact in E.164 format
  • primary_contact*: True if contact is the primary contact for the group
  • title*: Job title of the group contact
  • types*: List of contact types for the group contact. One or more of: billing, company, executive, online
  • version*: Current version of the record

Get a single agent contact

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/agents/83359c7e-a14c-4381-8826-c81f026ba947/contacts/a4e746df-ff1d-46ad-a8eb-f64b72acb828

Example Response

{
    "agent_id": "83359c7e-a14c-4381-8826-c81f026ba947",
    "created": 1628617987,
    "email": "michele.gorczany@gmail.com",
    "first_name": "Michele",
    "id": "a4e746df-ff1d-46ad-a8eb-f64b72acb828",
    "last_name": "Gorczany",
    "modified": 1628617987,
    "phone_number": "+15555551212",
    "title": "HR Professional",
    "types": [
        "billing"
    ],
    "version": "44f71d9f-9c6b-49d0-b2b2-2662334e3e16"
}

Returns the latest version of a single agent based on the ID provided

Path Parameters

agent_id The unique identifier of the agent in Noyo
contact_id The unique identifier of the agent contact in Noyo

Get a single agent contact response

agent_id* uuid Unique identifier of the agent in Noyo
created* timestamp The date the record was created
email* string Work email address of the agent contact
first_name* string First name of the agent contact
id* uuid Unique identifier of the record in Noyo
last_name* string Last name of the agent contact
modified* timestamp The date the record was last updated
phone_number string Work phone number of the agent contact in E.164 format
title* string Job title of the agent contact
types* array List of contact types for the agent contact. One of: billing, company, executive, online
version* uuid Current version of the record

Add agent contact

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/agents/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/contacts

Body Parameter


{
    "email": "michele.gorczany@gmail.com",
    "first_name": "Michele",
    "last_name": "Gorczany",
    "phone_number": "+15555551212",
    "title": "HR Professional",
    "types": [
        "billing"
    ]
}

Example Response

{
    "agent_id": "969a2b7a-4ce5-42fa-812f-11b7191d9179",
    "created": 1628617987,
    "email": "michele.gorczany@gmail.com",
    "first_name": "Michele",
    "id": "ba1d1878-1d24-48f0-9ec0-ef7d2a603abf",
    "last_name": "Gorczany",
    "modified": 1628617987,
    "phone_number": "+15555551212",
    "title": "HR Professional",
    "types": [
        "billing"
    ],
    "version": "44f71d9f-9c6b-49d0-b2b2-2662334e3e16"
}

Creates a new agent contact for an agent

Path Parameters

agent_id The unique identifier of the agent in Noyo

Request Body

email* string Work email address of the agent contact
first_name* string First name of the agent contact
last_name* string Last name of the agent contact
phone_number string Work phone number of the agent contact in E.164 format
title* string Job title of the agent contact
types* array List of contact types for the agent contact. One of: billing, company, executive, online

Create Agent Response

agent_id* uuid Unique identifier of the agent in Noyo
created* timestamp The date the record was created
email* string Work email address of the agent contact
first_name* string First name of the agent contact
id* uuid Unique identifier of the record in Noyo
last_name* string Last name of the agent contact
modified* timestamp The date the record was last updated
phone_number string Work phone number of the agent contact in E.164 format
title* string Job title of the agent contact
types* array List of contact types for the agent contact. One of: billing, company, executive, online
version* uuid Current version of the record

Edit an agent contact

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/agents/83359c7e-a14c-4381-8826-c81f026ba947/contacts/a4e746df-ff1d-46ad-a8eb-f64b72acb828/015228ff-ea2e-48b0-a916-581dbf87958c

Body Parameter


{
    "first_name": "Michele"
}

Example Response

{
    "agent_id": "83359c7e-a14c-4381-8826-c81f026ba947",
    "created": 1628617987,
    "email": "michele.gorczany@gmail.com",
    "first_name": "Michele",
    "id": "a4e746df-ff1d-46ad-a8eb-f64b72acb828",
    "last_name": "Gorczany",
    "modified": 1628617987,
    "phone_number": "+15555551212",
    "title": "HR Professional",
    "types": [
        "billing"
    ],
    "version": "44f71d9f-9c6b-49d0-b2b2-2662334e3e16"
}

Edit an agent contact based on the ID provided. The version parameter must match the latest agent contact version.

Path Parameters

agent_id The unique identifier of the agent in Noyo
contact_id The unique identifier of the agent contact in Noyo
version The current version identifier of the agent contact

Request Body

email string Work email address of the agent contact
first_name string First name of the agent contact
last_name string Last name of the agent contact
phone_number string Work phone number of the agent contact in E.164 format
title string Job title of the agent contact
types array List of contact types for the agent contact. One of: billing, company, executive, online

Edit Agent Contact Response

agent_id* uuid Unique identifier of the agent in Noyo
created* timestamp The date the record was created
email* string Work email address of the agent contact
first_name* string First name of the agent contact
id* uuid Unique identifier of the record in Noyo
last_name* string Last name of the agent contact
modified* timestamp The date the record was last updated
phone_number string Work phone number of the agent contact in E.164 format
title* string Job title of the agent contact
types* array List of contact types for the agent contact. One of: billing, company, executive, online
version* uuid Current version of the record

Group Coverage

Get all lines of coverage for an application

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/group_coverages

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "application_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "created": 1628617987,
            "id": "1aed3daf-ffd4-4f7f-9a39-1de02a18937c",
            "line_of_coverage": "medical",
            "modified": 1628617987,
            "notes": "",
            "requested_effective_date": "2022-01-01",
            "status": "in_progresss",
            "status_notes": "",
            "version": "fe5ac6c5-b245-40bc-b4b6-1b807ed2a619"
        }
    ]
}

Returns a list of all group coverages for a given application

Path Parameters

application_id The unique identifier of the application in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get all lines of coverage response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • application_id*: Unique identifier of the application in Noyo
  • created*: The date the record was created
  • existing_coverage: True if this line of coverage is currently active with the carrier
  • id*: Unique identifier of the record in Noyo
  • line_of_coverage*: The line of coverage requested with the carrier application. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
  • modified*: The date the record was last updated
  • notes: General platform notes about the group coverage
  • requested_effective_date*: Requested effective date for start of coverage
  • status*: Status of the coverage for a submitted application. One of: accepted, canceled, in_progresss, noyo_review, rejected, submitted
  • status_notes*: Additional notes about the group coverage status with the carrier
  • version*: Current version of the record

Get a single line of coverage

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/group_coverages/a4e746df-ff1d-46ad-a8eb-f64b72acb828

Example Response

{
    "application_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "created": 1628617987,
    "id": "1aed3daf-ffd4-4f7f-9a39-1de02a18937c",
    "line_of_coverage": "medical",
    "modified": 1628617987,
    "notes": "",
    "requested_effective_date": "2022-01-01",
    "status": "in_progresss",
    "status_notes": "",
    "version": "fe5ac6c5-b245-40bc-b4b6-1b807ed2a619"
}

Returns the latest version of a single group coverage based on the ID provided.

Path Parameters

group_coverage_id The unique identifier of the group coverage in Noyo

Get a single line of coverage response

application_id* uuid Unique identifier of the application in Noyo
created* timestamp The date the record was created
existing_coverage boolean True if this line of coverage is currently active with the carrier
id* uuid Unique identifier of the record in Noyo
line_of_coverage* string The line of coverage requested with the carrier application. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
modified* timestamp The date the record was last updated
notes string General platform notes about the group coverage
requested_effective_date* date Requested effective date for start of coverage
status* string Status of the coverage for a submitted application. One of: accepted, canceled, in_progresss, noyo_review, rejected, submitted
status_notes* string Additional notes about the group coverage status with the carrier
version* uuid Current version of the record

Add lines of coverage

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/group_coverages

Body Parameter


{
    "existing_coverage": false,
    "line_of_coverage": "medical",
    "notes": "",
    "requested_effective_date": "2022-01-01"
}

Example Response

{
    "application_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "created": 1628617987,
    "id": "1aed3daf-ffd4-4f7f-9a39-1de02a18937c",
    "line_of_coverage": "medical",
    "modified": 1628617987,
    "notes": "",
    "requested_effective_date": "2022-01-01",
    "status": "in_progresss",
    "status_notes": "",
    "version": "fe5ac6c5-b245-40bc-b4b6-1b807ed2a619"
}

Here you’ll be able to add the lines of coverage for your group, including type of coverage and the requested effective date.

Path Parameters

application_id The unique identifier of the application in Noyo

Request Body

existing_coverage boolean True if this line of coverage is currently active with the carrier
line_of_coverage* string The line of coverage requested with the carrier application. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
notes string General platform notes about the group coverage
requested_effective_date* date Requested effective date for start of coverage

Create Group Coverage Response

application_id* uuid Unique identifier of the application in Noyo
created* timestamp The date the record was created
existing_coverage boolean True if this line of coverage is currently active with the carrier
id* uuid Unique identifier of the record in Noyo
line_of_coverage* string The line of coverage requested with the carrier application. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
modified* timestamp The date the record was last updated
notes string General platform notes about the group coverage
requested_effective_date* date Requested effective date for start of coverage
status* string Status of the coverage for a submitted application. One of: accepted, canceled, in_progresss, noyo_review, rejected, submitted
status_notes* string Additional notes about the group coverage status with the carrier
version* uuid Current version of the record

Plans

Get all plans for a group coverage

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/group_coverages/a4e746df-ff1d-46ad-a8eb-f64b72acb828/coverage_plans

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "benefit_details": [
                "fsa"
            ],
            "code": "D1",
            "contribution_details": [
                {
                    "contribution_rule": {
                        "percentage": "90%"
                    },
                    "contribution_rule_type": "percent"
                }
            ],
            "created": 1628617987,
            "existing_plan": false,
            "group_coverage_id": "8d8b65e6-338e-4f49-86b0-b9a4ba18579d",
            "id": "62c22d5d-7cb3-4fc0-9d17-ed0bdc461afe",
            "modified": 1628617987,
            "network": "PPO",
            "notes": "",
            "plan_name": "Premium Gold Plan",
            "plan_type": "basic",
            "premium_details": {
                "amount": 45.0,
                "period": {
                    "amount": 1,
                    "unit": "month"
                },
                "premium_type": "total_amount"
            },
            "product_type": "gold",
            "status": "in_progress",
            "status_notes": "",
            "version": "5ae6fbcf-8a87-4042-b602-d223ad420e69"
        }
    ]
}

Returns a list of all coverage plans for a given group coverage

Path Parameters

group_coverage_id The unique identifier of the group coverage.

Get all plans response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • benefit_details: The add-on benefits offered by the plan.
  • cobra_rules:
    • eligible: True if group plan is eligible for COBRA enrollments
  • code: The code for the plan.
  • contribution_details:
    • contribution_rule*: The contribution rule
    • contribution_rule_type*: The type of contribution rule. One of: fixed_dollar, percent
  • coverage_details:
    • dependent_coverage: Boolean, whether dependent coverage is offered
    • elected_official_coverage: Boolean, whether elected official coverage is offered
    • retiree_coverage: Boolean, whether retiree coverage is offered
  • created*: The date the record was created
  • existing_plan: True if this plan is currently active with the carrier
  • group_coverage_id*: Unique identifier of the group coverage in Noyo
  • id*: Unique identifier of the record in Noyo
  • modified*: The date the record was last updated
  • network: Details about the plan network
  • notes: General platform notes about the coverage plan
  • plan_name*: Display name of the plan
  • plan_type: Plan type for basic or voluntary plans
  • premium_details:
    • amount*: Amount of the member premium
    • period*:
      • amount*: Length of premium period
      • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
    • premium_type*: Type of the member premium. One of: employee_amount, employer_amount, total_amount
  • product_type: Details about the product type
  • status*: Status of the coverage plan for a submitted application. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
  • status_notes*: Additional notes about the coverage plan status with the carrier
  • termination_policy: Termination policy for the coverage plan
  • version*: Current version of the record
  • volume_rules: Volume rules for the group critical illness plan
  • waiting_period_rules: The list of waiting period rules.

Get a single plan

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/coverage_plans/07bfdaf1-426f-4d58-b2d4-d1b04ffb79eb

Example Response

{
    "benefit_details": [
        "fsa"
    ],
    "code": "D1",
    "contribution_details": [
        {
            "contribution_rule": {
                "percentage": "90%"
            },
            "contribution_rule_type": "percent"
        }
    ],
    "created": 1628617987,
    "existing_plan": false,
    "group_coverage_id": "8d8b65e6-338e-4f49-86b0-b9a4ba18579d",
    "id": "62c22d5d-7cb3-4fc0-9d17-ed0bdc461afe",
    "modified": 1628617987,
    "network": "PPO",
    "notes": "",
    "plan_name": "Premium Gold Plan",
    "plan_type": "basic",
    "premium_details": {
        "amount": 45.0,
        "period": {
            "amount": 1,
            "unit": "month"
        },
        "premium_type": "total_amount"
    },
    "product_type": "gold",
    "status": "in_progress",
    "status_notes": "",
    "version": "5ae6fbcf-8a87-4042-b602-d223ad420e69"
}

Returns the latest version of a single coverage plan based on the ID provided.

Path Parameters

plan_id The unique identifier of the coverage plan in Noyo

Get a single plan response

benefit_details array The add-on benefits offered by the plan.
cobra_rules object
  • eligible: True if group plan is eligible for COBRA enrollments
code string The code for the plan.
contribution_details array
  • contribution_rule*: The contribution rule
  • contribution_rule_type*: The type of contribution rule. One of: fixed_dollar, percent
coverage_details object
  • dependent_coverage: Boolean, whether dependent coverage is offered
  • elected_official_coverage: Boolean, whether elected official coverage is offered
  • retiree_coverage: Boolean, whether retiree coverage is offered
created* timestamp The date the record was created
existing_plan boolean True if this plan is currently active with the carrier
group_coverage_id* uuid Unique identifier of the group coverage in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
network string Details about the plan network
notes string General platform notes about the coverage plan
plan_name* string Display name of the plan
plan_type string Plan type for basic or voluntary plans
premium_details object
  • amount*: Amount of the member premium
  • period*:
    • amount*: Length of premium period
    • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
  • premium_type*: Type of the member premium. One of: employee_amount, employer_amount, total_amount
product_type string Details about the product type
status* string Status of the coverage plan for a submitted application. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
status_notes* string Additional notes about the coverage plan status with the carrier
termination_policy string Termination policy for the coverage plan
version* uuid Current version of the record
volume_rules string Volume rules for the group critical illness plan
waiting_period_rules array The list of waiting period rules.

Add plans

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/group_coverages/a4e746df-ff1d-46ad-a8eb-f64b72acb828/coverage_plans

Body Parameter


{
    "benefit_details": [
        "fsa"
    ],
    "code": "D1",
    "contribution_details": [
        {
            "contribution_rule": {
                "percentage": "90%"
            },
            "contribution_rule_type": "percent"
        }
    ],
    "existing_plan": false,
    "network": "PPO",
    "notes": "",
    "plan_name": "Premium Gold Plan",
    "plan_type": "basic",
    "premium_details": {
        "amount": 45.0,
        "period": {
            "amount": 1,
            "unit": "month"
        },
        "premium_type": "total_amount"
    },
    "product_type": "gold"
}

Example Response

{
    "benefit_details": [
        "fsa"
    ],
    "code": "D1",
    "contribution_details": [
        {
            "contribution_rule": {
                "percentage": "90%"
            },
            "contribution_rule_type": "percent"
        }
    ],
    "created": 1628617987,
    "existing_plan": false,
    "group_coverage_id": "8d8b65e6-338e-4f49-86b0-b9a4ba18579d",
    "id": "62c22d5d-7cb3-4fc0-9d17-ed0bdc461afe",
    "modified": 1628617987,
    "network": "PPO",
    "notes": "",
    "plan_name": "Premium Gold Plan",
    "plan_type": "basic",
    "premium_details": {
        "amount": 45.0,
        "period": {
            "amount": 1,
            "unit": "month"
        },
        "premium_type": "total_amount"
    },
    "product_type": "gold",
    "status": "in_progress",
    "status_notes": "",
    "version": "5ae6fbcf-8a87-4042-b602-d223ad420e69"
}

Here you can associate a plan with a line of coverage and then pass information about the plan like the name, network, waiting periods, and other details.

Path Parameters

group_coverage_id The unique identifier of the group coverage in Noyo

Request Body

benefit_details array The add-on benefits offered by the plan.
cobra_rules object
  • eligible: True if group plan is eligible for COBRA enrollments
code string The code for the plan.
contribution_details array
  • contribution_rule*: The contribution rule
  • contribution_rule_type*: The type of contribution rule. One of: fixed_dollar, percent
coverage_details object
  • dependent_coverage: Boolean, whether dependent coverage is offered
  • elected_official_coverage: Boolean, whether elected official coverage is offered
  • retiree_coverage: Boolean, whether retiree coverage is offered
existing_plan boolean True if this plan is currently active with the carrier
network string Details about the plan network
notes string General platform notes about the coverage plan
plan_name* string Display name of the plan
plan_type string Plan type for basic or voluntary plans
premium_details object
  • amount*: Amount of the member premium
  • period*:
    • amount*: Length of premium period
    • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
  • premium_type*: Type of the member premium. One of: employee_amount, employer_amount, total_amount
product_type string Details about the product type
termination_policy string Termination policy for the coverage plan
volume_rules string Volume rules for the group critical illness plan
waiting_period_rules array The list of waiting period rules.

Create Coverage Plan Response

benefit_details array The add-on benefits offered by the plan.
cobra_rules object
  • eligible: True if group plan is eligible for COBRA enrollments
code string The code for the plan.
contribution_details array
  • contribution_rule*: The contribution rule
  • contribution_rule_type*: The type of contribution rule. One of: fixed_dollar, percent
coverage_details object
  • dependent_coverage: Boolean, whether dependent coverage is offered
  • elected_official_coverage: Boolean, whether elected official coverage is offered
  • retiree_coverage: Boolean, whether retiree coverage is offered
created* timestamp The date the record was created
existing_plan boolean True if this plan is currently active with the carrier
group_coverage_id* uuid Unique identifier of the group coverage in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
network string Details about the plan network
notes string General platform notes about the coverage plan
plan_name* string Display name of the plan
plan_type string Plan type for basic or voluntary plans
premium_details object
  • amount*: Amount of the member premium
  • period*:
    • amount*: Length of premium period
    • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
  • premium_type*: Type of the member premium. One of: employee_amount, employer_amount, total_amount
product_type string Details about the product type
status* string Status of the coverage plan for a submitted application. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
status_notes* string Additional notes about the coverage plan status with the carrier
termination_policy string Termination policy for the coverage plan
version* uuid Current version of the record
volume_rules string Volume rules for the group critical illness plan
waiting_period_rules array The list of waiting period rules.

Edit a plan

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/coverage_plans/07bfdaf1-426f-4d58-b2d4-d1b04ffb79eb/98c158ce-e9df-4dd0-b7a6-48472c6583a6

Body Parameter


{
    "plan_name": "Premium Silver Plan"
}

Example Response

{
    "benefit_details": [
        "fsa"
    ],
    "code": "D1",
    "contribution_details": [
        {
            "contribution_rule": {
                "percentage": "90%"
            },
            "contribution_rule_type": "percent"
        }
    ],
    "created": 1628617987,
    "existing_plan": false,
    "group_coverage_id": "8d8b65e6-338e-4f49-86b0-b9a4ba18579d",
    "id": "62c22d5d-7cb3-4fc0-9d17-ed0bdc461afe",
    "modified": 1628617987,
    "network": "PPO",
    "notes": "",
    "plan_name": "Premium Silver Plan",
    "plan_type": "basic",
    "premium_details": {
        "amount": 45.0,
        "period": {
            "amount": 1,
            "unit": "month"
        },
        "premium_type": "total_amount"
    },
    "product_type": "gold",
    "status": "in_progress",
    "status_notes": "",
    "version": "5ae6fbcf-8a87-4042-b602-d223ad420e69"
}

Edit a coverage plan based on the ID provided. The version parameter must match the latest coverage plan version.

Path Parameters

plan_id The unique identifier of the coverage plan in Noyo
version The current version identifier of the coverage plan

Request Body

benefit_details array The add-on benefits offered by the plan.
cobra_rules object
  • eligible: True if group plan is eligible for COBRA enrollments
code string The code for the plan.
contribution_details array
  • contribution_rule*: The contribution rule
  • contribution_rule_type*: The type of contribution rule. One of: fixed_dollar, percent
coverage_details object
  • dependent_coverage: Boolean, whether dependent coverage is offered
  • elected_official_coverage: Boolean, whether elected official coverage is offered
  • retiree_coverage: Boolean, whether retiree coverage is offered
existing_plan boolean True if this plan is currently active with the carrier
network string Details about the plan network
notes string General platform notes about the coverage plan
plan_name string Display name of the plan
plan_type string Plan type for basic or voluntary plans
premium_details object
  • amount*: Amount of the member premium
  • period*:
    • amount*: Length of premium period
    • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
  • premium_type*: Type of the member premium. One of: employee_amount, employer_amount, total_amount
product_type string Details about the product type
termination_policy string Termination policy for the coverage plan
volume_rules string Volume rules for the group critical illness plan
waiting_period_rules array The list of waiting period rules.

Edit Plan Response

benefit_details array The add-on benefits offered by the plan.
cobra_rules object
  • eligible: True if group plan is eligible for COBRA enrollments
code string The code for the plan.
contribution_details array
  • contribution_rule*: The contribution rule
  • contribution_rule_type*: The type of contribution rule. One of: fixed_dollar, percent
coverage_details object
  • dependent_coverage: Boolean, whether dependent coverage is offered
  • elected_official_coverage: Boolean, whether elected official coverage is offered
  • retiree_coverage: Boolean, whether retiree coverage is offered
created* timestamp The date the record was created
existing_plan boolean True if this plan is currently active with the carrier
group_coverage_id* uuid Unique identifier of the group coverage in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
network string Details about the plan network
notes string General platform notes about the coverage plan
plan_name* string Display name of the plan
plan_type string Plan type for basic or voluntary plans
premium_details object
  • amount*: Amount of the member premium
  • period*:
    • amount*: Length of premium period
    • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
  • premium_type*: Type of the member premium. One of: employee_amount, employer_amount, total_amount
product_type string Details about the product type
status* string Status of the coverage plan for a submitted application. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
status_notes* string Additional notes about the coverage plan status with the carrier
termination_policy string Termination policy for the coverage plan
version* uuid Current version of the record
volume_rules string Volume rules for the group critical illness plan
waiting_period_rules array The list of waiting period rules.

Employees

Get all employees

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/employees

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "created": 1628617987,
            "employment": {
                "employment_dates": {
                    "full_time_start": "2021-01-01",
                    "hire_date": "2021-01-01"
                },
                "employment_status": "full-time",
                "occupation": "CTO",
                "salary": {
                    "amount": 50000.0,
                    "type": "salary",
                    "unit": "annual"
                }
            },
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "id": "59a344a3-25ac-4b00-95ad-37ca518696e0",
            "modified": 1628617990,
            "person": {
                "contact": {
                    "email_address": "francis@testemail.com",
                    "email_address_type": "home",
                    "home_phone": "+12065551234"
                },
                "date_of_birth": "1984-01-02",
                "first_name": "Jaime",
                "home_address": {
                    "city": "San Francisco",
                    "county": "San Francisco",
                    "state": "CA",
                    "street_one": "1234 Home Ave",
                    "zip_code": "94107"
                },
                "last_name": "Johnson",
                "marital_status": "married",
                "sex": "M",
                "ssn": "987654320"
            },
            "version": "dd313db2-7aa1-4390-aa96-e3678091b57c"
        }
    ]
}

Returns a list of all employees for a given group

Path Parameters

group_id The unique identifier of the group in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get employees response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • created*: The date the record was created
  • employment*:
    • employment_dates:
      • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
      • hire_date: ISO-8601 date string for the hire date of the employee
      • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
      • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)
      • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
    • employment_status: Employee employment status at the company. One of: contract, disabled, full-time, part-time, retired, terminated
    • hours_worked: Number of hours worked per week by the employee
    • occupation: Employee occupation or job title
    • salary:
      • amount: Amount of salary earned by the employee in US dollars
      • type: Type of salary earned by the employee. One of: hourly, salary
      • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
  • group_id*: Unique identifier of the group in Noyo
  • id*: Unique identifier of the record in Noyo
  • modified*: The date the record was last updated
  • person*:
    • contact:
      • email_address: Email address of the person
      • email_address_type: Type of email address. One of: home, work
      • home_phone: Home phone number in E.164 format
      • preferred_language: Preferred written or spoken language of the person
      • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
      • speaks_english: True if the person can speak or communicate in English
      • work_phone: Work phone number in E.164 format
    • date_of_birth*: ISO-8601 date string for the date of birth of the person
    • details:
      • american_indian:
        • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
        • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
      • disability:
        • communication: True if the disability impacts the ability to communicate or read
        • disabled: True if the member has a disability
        • reason: Description of the disability
      • is_military: True if the person is in the military
      • is_student: True if the person is a student
      • tobacco:
        • duration: Duration of tobacco use
        • frequency: Frequency of tobacco use
        • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
        • user: True if the person uses tobacco of any kind
    • first_name*: First name of the person
    • home_address:
      • city*: City of the address
      • county: County of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • zip_code*: Zip code of the address
    • last_name*: Last name of the person
    • mailing_address:
      • city*: City of the address
      • county: County of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • zip_code*: Zip code of the address
    • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
    • middle_name: Middle name of the person
    • sex*: Sex of the person. One of: F, M, U
    • ssn: Social Security Number of the person
    • suffix: Suffix of the person
  • version*: Current version of the record

Get a single employee

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/employees/2613a221-d3c8-4c8a-86d5-e7e885fd1da9

Example Response

{
    "created": 1628617987,
    "employment": {
        "employment_dates": {
            "full_time_start": "2021-01-01",
            "hire_date": "2021-01-01"
        },
        "employment_status": "full-time",
        "occupation": "CTO",
        "salary": {
            "amount": 50000.0,
            "type": "salary",
            "unit": "annual"
        }
    },
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "59a344a3-25ac-4b00-95ad-37ca518696e0",
    "modified": 1628617990,
    "person": {
        "contact": {
            "email_address": "francis@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "1984-01-02",
        "first_name": "Jaime",
        "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "married",
        "sex": "M",
        "ssn": "987654320"
    },
    "version": "dd313db2-7aa1-4390-aa96-e3678091b57c"
}

Returns the latest version of a single employee based on the ID provided.

Path Parameters

employee_id The unique identifier of the employee in Noyo

Get a single employee response

created* timestamp The date the record was created
employment* object
  • employment_dates:
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • hire_date: ISO-8601 date string for the hire date of the employee
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
  • employment_status: Employee employment status at the company. One of: contract, disabled, full-time, part-time, retired, terminated
  • hours_worked: Number of hours worked per week by the employee
  • occupation: Employee occupation or job title
  • salary:
    • amount: Amount of salary earned by the employee in US dollars
    • type: Type of salary earned by the employee. One of: hourly, salary
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
version* uuid Current version of the record

Add employees

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/employees

Body Parameter


{
    "employment": {
        "employment_dates": {
            "full_time_start": "2021-01-01",
            "hire_date": "2021-01-01"
        },
        "employment_status": "full-time",
        "occupation": "CTO",
        "salary": {
            "amount": 50000.0,
            "type": "salary",
            "unit": "annual"
        }
    },
    "person": {
        "contact": {
            "email_address": "francis@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "1984-01-02",
        "first_name": "Francis",
        "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "married",
        "sex": "M",
        "ssn": "987654320"
    }
}

Example Response

{
    "created": 1628617987,
    "employment": {
        "employment_dates": {
            "full_time_start": "2021-01-01",
            "hire_date": "2021-01-01"
        },
        "employment_status": "full-time",
        "occupation": "CTO",
        "salary": {
            "amount": 50000.0,
            "type": "salary",
            "unit": "annual"
        }
    },
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "59a344a3-25ac-4b00-95ad-37ca518696e0",
    "modified": 1628617987,
    "person": {
        "contact": {
            "email_address": "francis@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "1984-01-02",
        "first_name": "Francis",
        "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "married",
        "sex": "M",
        "ssn": "987654320"
    },
    "version": "78f71504-2f53-4459-be71-6b7f6c30149e"
}

When you add employees to your group, you’ll pass information like their hire date, employment status, and basic demographic information (address, DOB, SSN, etc.).

Path Parameters

group_id The unique identifier of the group in Noyo

Request Body

employment object
  • employment_dates:
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • hire_date: ISO-8601 date string for the hire date of the employee
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
  • employment_status: Employee employment status at the company. One of: contract, disabled, full-time, part-time, retired, terminated
  • hours_worked: Number of hours worked per week by the employee
  • occupation: Employee occupation or job title
  • salary:
    • amount: Amount of salary earned by the employee in US dollars
    • type: Type of salary earned by the employee. One of: hourly, salary
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person

Create Employee Response

created* timestamp The date the record was created
employment* object
  • employment_dates:
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • hire_date: ISO-8601 date string for the hire date of the employee
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
  • employment_status: Employee employment status at the company. One of: contract, disabled, full-time, part-time, retired, terminated
  • hours_worked: Number of hours worked per week by the employee
  • occupation: Employee occupation or job title
  • salary:
    • amount: Amount of salary earned by the employee in US dollars
    • type: Type of salary earned by the employee. One of: hourly, salary
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
version* uuid Current version of the record

Edit an employee

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/employees/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/24b1f863-d249-48d1-a2b4-c61f0a437938

Body Parameter


{
    "person": {
        "first_name": "Jaime"
    }
}

Example Response

{
    "created": 1628617987,
    "employment": {
        "employment_dates": {
            "full_time_start": "2021-01-01",
            "hire_date": "2021-01-01"
        },
        "employment_status": "full-time",
        "occupation": "CTO",
        "salary": {
            "amount": 50000.0,
            "type": "salary",
            "unit": "annual"
        }
    },
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "59a344a3-25ac-4b00-95ad-37ca518696e0",
    "modified": 1628617990,
    "person": {
        "contact": {
            "email_address": "francis@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "1984-01-02",
        "first_name": "Jaime",
        "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "married",
        "sex": "M",
        "ssn": "987654320"
    },
    "version": "dd313db2-7aa1-4390-aa96-e3678091b57c"
}

Edit an employee based on the ID provided. The version parameter must match the latest employee version.

Path Parameters

employee_id The unique identifier of the employee in Noyo
version The current version identifier of the employee

Request Body

employment object
  • employment_dates:
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • hire_date: ISO-8601 date string for the hire date of the employee
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
  • employment_status: Employee employment status at the company. One of: contract, disabled, full-time, part-time, retired, terminated
  • hours_worked: Number of hours worked per week by the employee
  • occupation: Employee occupation or job title
  • salary:
    • amount: Amount of salary earned by the employee in US dollars
    • type: Type of salary earned by the employee. One of: hourly, salary
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
person object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex: Sex of the person. One of: F, M
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person

Edit Employee Response

created* timestamp The date the record was created
employment* object
  • employment_dates:
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • hire_date: ISO-8601 date string for the hire date of the employee
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
  • employment_status: Employee employment status at the company. One of: contract, disabled, full-time, part-time, retired, terminated
  • hours_worked: Number of hours worked per week by the employee
  • occupation: Employee occupation or job title
  • salary:
    • amount: Amount of salary earned by the employee in US dollars
    • type: Type of salary earned by the employee. One of: hourly, salary
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
group_id* uuid Unique identifier of the group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
version* uuid Current version of the record

Dependents

Get all dependents for an employee

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/employees/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/dependents

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "created": 1628617987,
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
            "modified": 1628617987,
            "person": {
                "contact": {
                    "email_address": "diane@testemail.com",
                    "email_address_type": "home",
                    "home_phone": "+12065551234"
                },
                "date_of_birth": "1982-01-02",
                "first_name": "Diane",
                "home_address": {
                    "city": "San Francisco",
                    "county": "San Francisco",
                    "state": "CA",
                    "street_one": "1234 Home Ave",
                    "zip_code": "94107"
                },
                "last_name": "Johnson",
                "marital_status": "",
                "sex": "F",
                "ssn": "987654321"
            },
            "relationship": "spouse",
            "version": "669fbe16-9960-4069-91aa-832ada3f4e42"
        }
    ]
}

Returns a list of all dependents for a given employee

Path Parameters

employee_id The unique identifier of the employee in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get all dependents response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • created*: The date the record was created
  • employee_id*: Unique identifier of the employee in Noyo
  • id*: Unique identifier of the record in Noyo
  • modified*: The date the record was last updated
  • person*:
    • contact:
      • email_address: Email address of the person
      • email_address_type: Type of email address. One of: home, work
      • home_phone: Home phone number in E.164 format
      • preferred_language: Preferred written or spoken language of the person
      • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
      • speaks_english: True if the person can speak or communicate in English
      • work_phone: Work phone number in E.164 format
    • date_of_birth*: ISO-8601 date string for the date of birth of the person
    • details:
      • american_indian:
        • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
        • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
      • disability:
        • communication: True if the disability impacts the ability to communicate or read
        • disabled: True if the member has a disability
        • reason: Description of the disability
      • is_military: True if the person is in the military
      • is_student: True if the person is a student
      • tobacco:
        • duration: Duration of tobacco use
        • frequency: Frequency of tobacco use
        • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
        • user: True if the person uses tobacco of any kind
    • first_name*: First name of the person
    • home_address:
      • city*: City of the address
      • county: County of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • zip_code*: Zip code of the address
    • last_name*: Last name of the person
    • mailing_address:
      • city*: City of the address
      • county: County of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • zip_code*: Zip code of the address
    • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
    • middle_name: Middle name of the person
    • sex*: Sex of the person. One of: F, M, U
    • ssn: Social Security Number of the person
    • suffix: Suffix of the person
  • relationship*: Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
  • version*: Current version of the record

Get a single dependent

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/dependents/5e8d64cd-9152-4791-884d-bd2bd4899f17

Example Response

{
    "created": 1628617987,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "id": "5e8d64cd-9152-4791-884d-bd2bd4899f17",
    "modified": 1628617987,
    "person": {
        "contact": {
            "email_address": "diane@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "1982-01-02",
        "first_name": "Diane",
        "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "married",
        "sex": "F",
        "ssn": "987654321"
    },
    "relationship": "spouse",
    "version": "669fbe16-9960-4069-91aa-832ada3f4e42"
}

Returns the latest version of a single dependent based on the ID provided.

Path Parameters

dependent_id The unique identifier of the dependent in Noyo

Get a single dependent response

created* timestamp The date the record was created
employee_id* uuid Unique identifier of the employee in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
version* uuid Current version of the record

Add dependents

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/employees/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/dependents

Body Parameter


{
    "person": {
        "contact": {
            "email_address": "jamie@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "2000-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",
        "marital_status": "single",
        "sex": "F",
        "ssn": "384032999"
    },
    "relationship": "child"
}

Example Response

{
    "created": 1628617987,
    "employee_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "5e8d64cd-9152-4791-884d-bd2bd4899f17",
    "modified": 1628617987,
    "person": {
        "contact": {
            "email_address": "jamie@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "2000-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",
        "marital_status": "single",
        "sex": "F",
        "ssn": "384032999"
    },
    "relationship": "child",
    "version": "dd321baa-a48f-4e09-9709-827c3f0eb660"
}

Now, you can associate dependents who are electing coverage with respective employees.

Path Parameters

employee_id The unique identifier of the employee in Noyo

Request Body

person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child

Create Dependent Response

created* timestamp The date the record was created
employee_id* uuid Unique identifier of the employee in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
version* uuid Current version of the record

Edit a dependent

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/dependents/5e8d64cd-9152-4791-884d-bd2bd4899f17/dd321baa-a48f-4e09-9709-827c3f0eb660

Body Parameter


{
    "relationship": "child"
}

Example Response

{
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "id": "5e8d64cd-9152-4791-884d-bd2bd4899f17",
    "person": {
        "contact": {
            "email_address": "diane@testemail.com",
            "email_address_type": "home",
            "home_phone": "+12065551234"
        },
        "date_of_birth": "1982-01-02",
        "first_name": "Diane",
        "home_address": {
            "city": "San Francisco",
            "county": "San Francisco",
            "state": "CA",
            "street_one": "1234 Home Ave",
            "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "",
        "sex": "F",
        "ssn": "987654321"
    },
    "relationship": "child",
    "version": "669fbe16-9960-4069-91aa-832ada3f4e42"
}

Edit a dependent based on the ID provided. The version parameter must match the latest dependent version.

Path Parameters

dependent_id The unique identifier of the employee in Noyo
version The current version identifier of the dependent

Request Body

person object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex: Sex of the person. One of: F, M
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
relationship string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child

Edit Dependent Response

created* timestamp The date the record was created
employee_id* uuid Unique identifier of the employee in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
person* object
  • contact:
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • home_phone: Home phone number in E.164 format
    • preferred_language: Preferred written or spoken language of the person
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • speaks_english: True if the person can speak or communicate in English
    • work_phone: Work phone number in E.164 format
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • details:
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • disability:
      • communication: True if the disability impacts the ability to communicate or read
      • disabled: True if the member has a disability
      • reason: Description of the disability
    • is_military: True if the person is in the military
    • is_student: True if the person is a student
    • tobacco:
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • user: True if the person uses tobacco of any kind
  • first_name*: First name of the person
  • home_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • last_name*: Last name of the person
  • mailing_address:
    • city*: City of the address
    • county: County of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • zip_code*: Zip code of the address
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • middle_name: Middle name of the person
  • sex*: Sex of the person. One of: F, M, U
  • ssn: Social Security Number of the person
  • suffix: Suffix of the person
relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
version* uuid Current version of the record

Member Elections

Get all member elections for a coverage plan

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/coverage_plans/a7356150-6c76-462d-a771-a88b50daabff/member_elections

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "created": 1628617987,
            "id": "51c43bdf-45dd-4361-8b97-047dfa22cf02",
            "member_id": "ba9c73a6-d0a6-47f6-b32c-50fd37961651",
            "member_type": "employee",
            "modified": 1628617987,
            "plan_id": "47a4b463-fb15-4d10-b3c3-69a619f166ba",
            "status": "enrolling",
            "version": "383c864b-ab89-44bf-93b7-abab4ced0bd9"
        }
    ]
}

Returns a list of all member elections for a given coverage plan

Path Parameters

plan_id The unique identifier of the coverage plan in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get member elections response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • created*: The date the record was created
  • id*: Unique identifier of the record in Noyo
  • member_id*: Unique identifier of the member in Noyo
  • member_type*: Type of member electing or waiving coverage. One of: dependent, employee
  • modified*: The date the record was last updated
  • plan_id*: Unique identifier of the coverage plan in Noyo
  • status*: Status of the member election on the coverage plan. One of: enrolling, waiving
  • version*: Current version of the record
  • volume: Volume amount requested for the enrolling member

Get a single member election

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/member_elections/2613a221-d3c8-4c8a-86d5-e7e885fd1da9

Example Response

{
    "created": 1628617987,
    "id": "51c43bdf-45dd-4361-8b97-047dfa22cf02",
    "member_id": "ba9c73a6-d0a6-47f6-b32c-50fd37961651",
    "member_type": "employee",
    "modified": 1628617987,
    "plan_id": "47a4b463-fb15-4d10-b3c3-69a619f166ba",
    "status": "enrolling",
    "version": "383c864b-ab89-44bf-93b7-abab4ced0bd9"
}

Returns a member election.

Path Parameters

member_election_id The unique identifier of the member election

Get a single member election response

created* timestamp The date the record was created
id* uuid Unique identifier of the record in Noyo
member_id* uuid Unique identifier of the member in Noyo
member_type* string Type of member electing or waiving coverage. One of: dependent, employee
modified* timestamp The date the record was last updated
plan_id* uuid Unique identifier of the coverage plan in Noyo
status* string Status of the member election on the coverage plan. One of: enrolling, waiving
version* uuid Current version of the record
volume string Volume amount requested for the enrolling member

Add member elections

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/coverage_plans/a7356150-6c76-462d-a771-a88b50daabff/member_elections

Body Parameter


{
    "member_id": "ba9c73a6-d0a6-47f6-b32c-50fd37961651",
    "member_type": "employee",
    "status": "enrolling"
}

Example Response

{
    "created": 1628617987,
    "id": "51c43bdf-45dd-4361-8b97-047dfa22cf02",
    "member_id": "ba9c73a6-d0a6-47f6-b32c-50fd37961651",
    "member_type": "employee",
    "modified": 1628617987,
    "plan_id": "47a4b463-fb15-4d10-b3c3-69a619f166ba",
    "status": "enrolling",
    "version": "383c864b-ab89-44bf-93b7-abab4ced0bd9"
}

Create a new member election for an coverage plan

Path Parameters

plan_id The unique identifier of the coverage plan in Noyo

Request Body

member_id* uuid Unique identifier of the member in Noyo
member_type* string Type of member electing or waiving coverage. One of: dependent, employee
status* string Status of the member election on the coverage plan. One of: enrolling, waiving
volume string Volume amount requested for the enrolling member

Create Member Election Response

created* timestamp The date the record was created
id* uuid Unique identifier of the record in Noyo
member_id* uuid Unique identifier of the member in Noyo
member_type* string Type of member electing or waiving coverage. One of: dependent, employee
modified* timestamp The date the record was last updated
plan_id* uuid Unique identifier of the coverage plan in Noyo
status* string Status of the member election on the coverage plan. One of: enrolling, waiving
version* uuid Current version of the record
volume string Volume amount requested for the enrolling member

Edit a member election

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/member_elections/94e57625-1c0d-47fe-9a63-fe7320ecef12/dcf941c6-094d-450a-9ed6-b15bbdb2188d

Body Parameter


{
    "status": "waiving"
}

Example Response

{
    "created": 1628617987,
    "id": "51c43bdf-45dd-4361-8b97-047dfa22cf02",
    "member_id": "ba9c73a6-d0a6-47f6-b32c-50fd37961651",
    "member_type": "employee",
    "modified": 1628617987,
    "plan_id": "47a4b463-fb15-4d10-b3c3-69a619f166ba",
    "status": "waiving",
    "version": "383c864b-ab89-44bf-93b7-abab4ced0bd9"
}

Edit a member election based on the ID provided. The version parameter must match the latest member election version.

Path Parameters

member_election_id The unique identifier of the member election in Noyo
version The current version identifier of the member election

Request Body

plan_id uuid Unique identifier of the coverage plan in Noyo
status string Status of the member election on the coverage plan. One of: enrolling, waiving
volume string Volume amount requested for the enrolling member

Edit Member Election Response

created* timestamp The date the record was created
id* uuid Unique identifier of the record in Noyo
member_id* uuid Unique identifier of the member in Noyo
member_type* string Type of member electing or waiving coverage. One of: dependent, employee
modified* timestamp The date the record was last updated
plan_id* uuid Unique identifier of the coverage plan in Noyo
status* string Status of the member election on the coverage plan. One of: enrolling, waiving
version* uuid Current version of the record
volume string Volume amount requested for the enrolling member

Document upload

Get all application documents for an application

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/documents

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "application_id": "93431a48-6174-49f2-9c29-a60c9fb99b80",
            "created": 1628617987,
            "file_upload_id": "a2f27a71-48ca-476e-9096-68422c2afcbf",
            "id": "13794bc7-0bd9-45a4-9655-ba9ce2f2eff5",
            "modified": 1628617987,
            "name": "My File",
            "notes": "",
            "required": true,
            "status": "in_progress",
            "status_notes": "",
            "template_file_key": "https://example.noyo.com/templates/test-group/UniversalApplication.pdf",
            "version": "9d085fb5-1cdb-4987-b683-73bda1097682"
        }
    ]
}

Get a list of all documents associated with a carrier application.

Path Parameters

application_id The unique identifier of the application in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get application documents response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • application_id*: Unique identifier of the application in Noyo
  • created*: The date the record was created
  • file_upload_id: Unique identifier of the file upload id
  • id*: Unique identifier of the record in Noyo
  • modified*: The date the record was last updated
  • name*: Display name of the application document
  • notes*: General platform notes about the application document
  • required*: True if this document is required to submit the application
  • status*: Status of the application document. One of: accepted, in_progress, incomplete, rejected, submitted
  • status_notes*: Additional notes about the application document status with the carrier
  • template_file_key*: GCS link to the template file stored in Noyo, if available
  • version*: Current version of the record

Get a single application document

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9

Example Response

{
    "application_type": "new",
    "carrier_id": "7368753c-5fdb-4cad-b70b-e97c48731f06",
    "created": 1628693051,
    "group_id": "99b18a62-29f1-4586-85e8-de9dfb28987c",
    "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "modified": 1628693051,
    "notes": "",
    "status": "in_progress",
    "status_notes": "",
    "version": "fb4e01c4-e054-4bd4-9948-f464a1931a00"
}

Returns the latest version of a single group application based on the ID provided.

Path Parameters

application_id The unique identifier of the application in Noyo

Get a single application document response

application_id* uuid Unique identifier of the application in Noyo
created* timestamp The date the record was created
file_upload_id uuid Unique identifier of the file upload id
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
name* string Display name of the application document
notes* string General platform notes about the application document
required* boolean True if this document is required to submit the application
status* string Status of the application document. One of: accepted, in_progress, incomplete, rejected, submitted
status_notes* string Additional notes about the application document status with the carrier
template_file_key* string GCS link to the template file stored in Noyo, if available
version* uuid Current version of the record

Create an application document

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/documents

Body Parameter


{
    "name": "My File",
    "notes": ""
}

Example Response

{
    "application_id": "93431a48-6174-49f2-9c29-a60c9fb99b80",
    "created": 1628617987,
    "file_upload_id": "a2f27a71-48ca-476e-9096-68422c2afcbf",
    "id": "13794bc7-0bd9-45a4-9655-ba9ce2f2eff5",
    "modified": 1628617987,
    "name": "My File",
    "notes": "",
    "required": true,
    "status": "in_progress",
    "status_notes": "",
    "template_file_key": "https://example.noyo.com/templates/test-group/UniversalApplication.pdf",
    "version": "9d085fb5-1cdb-4987-b683-73bda1097682"
}

Create a new document submission attached to an application. This endpoint provisions a new document upload and creates a new application document to be attached to the application. Use this endpoint to submit any files not already requested by the application.

Path Parameters

application_id The unique identifier of the application in Noyo

Request Body

name* string Display name of the application document
notes* string General platform notes about the application document

Create Application Document Response

application_id* uuid Unique identifier of the application in Noyo
created* timestamp The date the record was created
file_upload_id uuid Unique identifier of the file upload id
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
name* string Display name of the application document
notes* string General platform notes about the application document
required* boolean True if this document is required to submit the application
status* string Status of the application document. One of: accepted, in_progress, incomplete, rejected, submitted
status_notes* string Additional notes about the application document status with the carrier
template_file_key* string GCS link to the template file stored in Noyo, if available
version* uuid Current version of the record

Upload an application document

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://document-upload.noyo.com/api/v1/files/e0b5e77b-d1bb-4a0f-a323-79c1ab9f3f06

Body (sent as MIME type multipart/form-data)

`file` should be the file contents

Example Response

204 No Content

Once you have created an application document, you may upload the associated file to our document upload service.

Send in the file to the document upload service as file in form data. Asychronously, we will associate this file with your application document record, using the common file_upload_id.

Path Parameters

file_upload_id The unique identifier you received when creating the application document in the group install service











Edit an application document

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/documents/b257bf08-75d9-495c-9b9f-ea12a574d176/408bb91b-83db-4cc0-a562-109603a55488

Body Parameter


{
    "notes": "This census is from August 2021"
}

Example Response

{
    "application_id": "93431a48-6174-49f2-9c29-a60c9fb99b80",
    "created": 1628617987,
    "file_upload_id": "a2f27a71-48ca-476e-9096-68422c2afcbf",
    "id": "13794bc7-0bd9-45a4-9655-ba9ce2f2eff5",
    "modified": 1628617987,
    "name": "My File",
    "notes": "This census is from August 2021",
    "required": true,
    "status": "in_progress",
    "status_notes": "",
    "template_file_key": "https://example.noyo.com/templates/test-group/UniversalApplication.pdf",
    "version": "9d085fb5-1cdb-4987-b683-73bda1097682"
}

Edit an application document based on the ID provided. The version parameter must match the latest application document version. When the group_file_id is not present, this method will update properties and metadata about an existing application document. When a group_file_id is provided, this method will verify that the file belongs to the same group as the application, and then associate that previously uploaded group file with this application document.

Path Parameters

application_id The unique identifier of the application in Noyo
document_id The unique identifier of the application document in Noyo
version The current version identifier of the application document

Request Body

group_file_id uuid Unique identifier of an existing group file in Noyo
name string Display name of the application document
notes string General platform notes about the application document

Edit Application Document Response

application_id* uuid Unique identifier of the application in Noyo
created* timestamp The date the record was created
file_upload_id uuid Unique identifier of the file upload id
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
name* string Display name of the application document
notes* string General platform notes about the application document
required* boolean True if this document is required to submit the application
status* string Status of the application document. One of: accepted, in_progress, incomplete, rejected, submitted
status_notes* string Additional notes about the application document status with the carrier
template_file_key* string GCS link to the template file stored in Noyo, if available
version* uuid Current version of the record

Application submission

Once all the required documents have been uploaded to Noyo and associated with the application, you can then update the Application status to submitted to kick off the full submission to the carrier. At this point, we will run some validations on the entirety of the application. If anything is amiss, we will return 422 from this request. If required, this is where you may upload a signature, (e.g. PNG file) along with the application.

Code Sample

curl -X PATCH
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://group-installation.noyo.com/api/v1/applications/aef5eb2a-1084-46dc-a6cc-aa56958495ff/7b8a7747-8e67-40fd-a9a3-a411cdd9a2d8

Body Parameter


{
    "status": "submitted"
}

Example Response

{
    "application_type": "new",
    "carrier_id": "0b220d37-2057-465c-99af-b5cb10f4d172",
    "created": 1628617987,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "id": "ba1d1878-1d24-48f0-9ec0-ef7d2a603abf",
    "modified": 1628617987,
    "notes": "",
    "status": "submitted",
    "status_notes": "",
    "version": "44f71d9f-9c6b-49d0-b2b2-2662334e3e16"
}

Edit a group application based on the ID provided. The version parameter must match the latest group application version. In addition to editing the application, if you change the 'status' field to 'submitted', Noyo will mark the application complete and submit the application to the carrier.

Path Parameters

application_id The unique identifier of the group application in Noyo
version The current version identifier of the group application

Request Body

carrier_group_id string An id given by the carrier to identify the group.
notes string General platform notes about the group application
status string Status of the application for the group. One of: canceled, submitted

Edit Group Application Response

application_type* string Type of application for the group with this carrier. One of: new, renewal, upsell
carrier_group_id* string An id given by the carrier to identify the group. e.g. policy_number, group_number or customer_id
carrier_id* uuid Unique identifier of the associated carrier in Noyo
created* timestamp The date the record was created
group_id* uuid Unique identifier of the associated group in Noyo
id* uuid Unique identifier of the record in Noyo
modified* timestamp The date the record was last updated
notes* string General platform notes about the group application
status* string Status of the application for the group. One of: accepted, canceled, in_progress, noyo_review, rejected, submitted
status_notes* string Additional notes about the application status with the carrier
version* uuid Current version of the record

Group Connections

Group connections enable you to set up a carrier connection through Noyo for a group that you administer. To create a group connection, the group must already be installed in the carrier’s system, and Noyo must have permission to manage enrollments for the group.

Note: If you installed the group with the carrier through Noyo, you do not need to set up a connection as well.

Get Single Group Connection

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/group_connections/dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1

Example Response

{
    "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
    "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b",
    "created": 1557329939,
    "modified": 1557329939,
    "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
    "group_id": "9e629e41-c706-4efd-9fbb-1ff2573fc67e",
    "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
    "request_type": "initial",
    "status": "completed",
    "group_data": {
        "carrier_group_id": "10000000",
        "group_name": "Test Company"
    },
    "setup_result": {}
}

Returns the latest status of a single group connection based on the ID provided.

Path Parameters

connection_id The unique identifier of the group connection you would like to view

Get Single Group Connection Response

Setup Result

The setup_result's structure will depend on the group connection's status.

If in noyo_review, action_required, waiting_on_carrier, or unable_to_connect statuses, it may contain an error string that gives further details about the specific issue involved.

For other statuses, the setup_result will be empty.

id* uuid Unique identifier of the group connection in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
organization_id* uuid Unique identifier of the platform or broker organization in Noyo
group_id uuid ID of associated group model
carrier_id* uuid Unique identifier of the carrier in Noyo
request_type* string Type of the group connection
status* string Status of the group connection. One of: action_required, carrier_authorization, completed, created, noyo_review, processing, unable_to_connect, waiting_on_carrier
group_data* object
  • carrier_group_id*: Unique identifier for the group in the carrier system
  • group_name*: Name for the group in the Noyo system
setup_result* object More information about the result of the group connection

Get Group Connections

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/group_connections

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
            "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b",
            "created": 1557329939,
            "modified": 1557329939,
            "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
            "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
            "request_type": "initial",
            "status": "processing",
            "group_data": {
                "carrier_group_id": "10000000",
                "group_name": "Test Company"
            }
        }
    ]
}

Returns a list of all group connection requests.

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
status Status of the group connection for which you would like to filter. Multiple statuses can be used, separated by a comma.
carrier_id The unique identifier of the carrier for which you would like to view group connection requests
organization_id The unique identifier of the organization for which you would like to view group connection requests
sort_by The attribute on which to sort the group connections
sort_direction Either asc or desc, to denote the data's direction

Get All Group Connections Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the group connection in Noyo
  • version*: Current version of the record
  • created*: The date the record was created
  • modified*: The date the record was last updated
  • organization_id*: Unique identifier of the platform or broker organization in Noyo
  • group_id: ID of associated group model
  • carrier_id*: Unique identifier of the carrier in Noyo
  • request_type*: Type of the group connection
  • status*: Status of the group connection. One of: action_required, carrier_authorization, completed, created, noyo_review, processing, unable_to_connect, waiting_on_carrier
  • group_data*:
    • carrier_group_id*: Unique identifier for the group in the carrier system
    • group_name*: Name for the group in the Noyo system
  • setup_result*: More information about the result of the group connection

Group Connections in a Group

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2ce3b54a-2535-4803-b218-e6b44081d418/group_connections

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
            "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b",
            "created": 1557329939,
            "modified": 1557329939,
            "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
            "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
            "request_type": "initial",
            "status": "processing",
            "group_data": {
                "carrier_group_id": "10000000",
                "group_name": "Test Company"
            }
        }
    ]
}

Returns a list of all group connection requests for a given group ID.

Path Parameters

group_id The unique identifier of the associated group in Noyo

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
sort_by The attribute on which to sort the group connections
sort_direction Either asc or desc, to denote the data's direction
status Status of group connection for which you would like to filter. Multiple statuses can be used, separated by a comma.

Create Group Connection

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/group_connections

Body Parameter


{
    "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
    "federal_ein": "123456789",
    "group_data": {
        "carrier_group_id": "10000000",
        "group_name": "Test Company"
    }
}

Example Response

{
    "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
    "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b",
    "created": 1557329939,
    "modified": 1557329939,
    "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
    "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
    "group_id": "47c07963-2e34-4da2-86b4-cbc3c57111c1",
    "request_type": "initial",
    "status": "created",
    "group_data": {
        "carrier_group_id": "10000000",
        "group_name": "Test Company"
    }
}

Create a new connection for a brand new group with a given carrier

Request Body

carrier_id* uuid Unique identifier of the carrier in Noyo
federal_ein string Federal Employer Identification Number for the new group/company
group_data* object
  • carrier_group_id*: Unique identifier for the group in the carrier system
  • group_name*: Name for the group in the Noyo system
  • broker_federal_ein: Federal Employer Identification Number for the group's broker. Only needed where relevant for carrier authorization

Create Group Connection Response

id* uuid Unique identifier of the group connection in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
organization_id* uuid Unique identifier of the platform or broker organization in Noyo
group_id uuid ID of associated group model
carrier_id* uuid Unique identifier of the carrier in Noyo
request_type* string Type of the group connection
status* string Status of the group connection. One of: action_required, carrier_authorization, completed, created, noyo_review, processing, unable_to_connect, waiting_on_carrier
group_data* object
  • carrier_group_id*: Unique identifier for the group in the carrier system
  • group_name*: Name for the group in the Noyo system
setup_result* object More information about the result of the group connection

Error Cases

Error Name Response Status Code Description
Duplicate 409 Submitting a duplicate group connection (identical carrier_id and carrier_group_id as another group connection) will result in a 409 conflict error.
Missing Fields 422 If any required fields are missing, the request will result in a 422.
Carrier Group ID Format 422 Submitting a carrier_group_id that violates carrier-specific formatting will result in a 422 error. Ask Noyo for specifics on different carrier group ID formats.

Adding Another Carrier

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/group_connections

Body Parameter


{
    "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
    "group_data": {
        "carrier_group_id": "10000000"
    }
}

Example Response

{
    "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
    "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b",
    "created": 1557329939,
    "modified": 1557329939,
    "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
    "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
    "group_id": "47c07963-2e34-4da2-86b4-cbc3c57111c1",
    "request_type": "incremental",
    "status": "created",
    "group_data": {
        "carrier_group_id": "10000000"
    }
}

Create a new carrier connection for an existing group

Path Parameters

group_id The unique identifier of the group for which you would like to add a carrier connection
carrier_id* uuid Unique identifier of the carrier in Noyo
group_data* object
  • carrier_group_id*: Unique identifier for the group in the carrier system
  • broker_federal_ein: Federal Employer Identification Number for the group's broker. Only needed where relevant for carrier authorization

Policy Management

Creating Member Requests

Member requests and member transactions are the heart and soul of the Noyo group benefits API. They represent the core operations you want to carry out on behalf of members (employees and dependents) at one or many carriers. The following types of member requests are supported by the Noyo platform:

Each member request is attached to an employee, changes you wish to make to dependents are done via a member request attached to the employee. Each member request will contain many member transactions, which represent smaller sub-operations being carried out at a carrier partner. For example, a New Hire Enrollment member request may result in two member transactions: one to add medical coverage at Carrier A, and a second to add dental and vision coverage at Carrier B. More details about member requests and associated transactions follows.

Member Request Statuses

The following are possible member request statuses that you might receive when fetching member request(s) from the API.

Key Description
processing We are communicating the member request changes to the carrier(s) involved.
completed A request is completed after all transactions with all carriers have been processed. This may take seconds or longer, depending on the carrier and request type. The results of the member request have been reflected in the carrier system at this point.
failed Requests will only move to the failed status if for an unexpected reason we were unable to fulfill at the carrier. You should expect very few member requests to transition into this status.
canceled Requests will be moved to the canceled status if a subsequent member request supersedes it, the most common example is the Enrollment Snapshot member request overriding changes made via a New Hire Enrollment member request.

As far as state transitions, expect the progression to be linear, from processing to either completed, failed, or canceled. Once in completed, failed, or canceled a member request will not move back to processing. The proper response from a failed member request, if not desired, would be to recreate the attempted changes in a new member request.

Renewal Readiness

This object enables you to send renewal decisions for a group, so that Noyo can confirm that a carrier is ready to receive new plan year member requests. A renewal decision includes line of coverage and plan information, as well as an overarching renewal date. Noyo will then continuously check the carrier's system to confirm that your decisions have been processed. If expectations are met, we will update the status to ready and you can start sending member requests. Otherwise, we will update the status to not_ready and inform you of the issues.

Get Renewal Decisions by Group

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/renewal_decisions

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6",
            "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e",
            "created": 1557862286,
            "modified": 1557862286,
            "status": "not_ready",
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "renewal_date": "2022-01-01",
            "body": {
                "carriers": [
                    {
                        "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4",
                        "lines_of_coverage": {
                            "medical": {
                                "open_enrollment_start_date": "2022-01-01",
                                "open_enrollment_end_date": "2022-01-31",
                                "plans": [
                                    {
                                        "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468",
                                        "name": "Select Plus PPO HDHP Gold BRJJ /C38"
                                    },
                                    {
                                        "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2",
                                        "name": "Select Plus PPO HDHP Silver BRJJ /C38"
                                    },
                                    {
                                        "plan_id": "19437852-3795-4cb4-939c-a86543eabee0",
                                        "name": "Select Plus PPO HDHP Bronze BRJJ /C38"
                                    }
                                ]
                            },
                            "dental": {
                                "open_enrollment_start_date": "2022-01-01",
                                "open_enrollment_end_date": "2022-01-31",
                                "plans": [
                                    {
                                        "plan_id": "44bc0f4a-0a94-11ec-9a03-0242ac130003",
                                        "name": "Dental Plus Plan"
                                    }
                                ]
                            }
                        }
                    }
                ]
            },
            "issues": [
                {
                    "level": "error",
                    "message": "Life open enrollment start date is 2021-08-01 in carrier system"
                },
                {
                    "level": "error",
                    "message": "LTD Plan not available yet in carrier system"
                }
            ]
        }
    ]
}

Returns all renewal decisions for a group. This includes the status, which determines whether the carrier is ready to accept member requests for the new plan year. If the status is not_ready, Noyo will return one or more issues, each with a level and message.

Path Parameters

group_id The unique identifier of the group for which you are retrieving renewal decisions

Query Parameters

renewal_date Renewal date to filter by, exact match

Get Renewal Decisions by Group Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the record in Noyo
  • version*: Current version of the record
  • created*: The date the record was created
  • modified*: The date the record was last updated
  • status*: The status on whether or not the renewal decision matches the carrier system. One of: not_ready, ready, submitted
  • group_id*: Group ID for the group related to the open enrollment period
  • renewal_date*: The renewal (start) date for this particular open enrollment period
  • body*:
    • carriers*:
      • carrier_id*: Unique identifier of the carrier in Noyo
      • lines_of_coverage:
        • medical:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans*:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • dental:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • vision:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • life:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • add:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • std:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • ltd:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • accident:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • critical_illness:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • cancer:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
        • hospital_indemnity:
          • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
          • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
          • plans:
            • plan_id: Unique ID of a group plan that exists in the Noyo system
            • name: Name of the group plan
  • issues*:
    • level*: The level or severity of the issue found. One of: error, warning
    • message*: Message describing the issue found and any steps to resolve

Get Renewal Decision by ID

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/renewal_decisions/4093a441-d4c8-4c8a-24d1-e7a132fb1bc2

Example Response

{
    "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6",
    "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e",
    "created": 1557862286,
    "modified": 1557862286,
    "status": "not_ready",
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "renewal_date": "2022-01-01",
    "body": {
        "carriers": [
            {
                "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4",
                "lines_of_coverage": {
                    "medical": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468",
                                "name": "Select Plus PPO HDHP Gold BRJJ /C38"
                            },
                            {
                                "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2",
                                "name": "Select Plus PPO HDHP Silver BRJJ /C38"
                            },
                            {
                                "plan_id": "19437852-3795-4cb4-939c-a86543eabee0",
                                "name": "Select Plus PPO HDHP Bronze BRJJ /C38"
                            }
                        ]
                    },
                    "dental": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "81803f12-0a96-11ec-9a03-0242ac130003",
                                "name": "Dental Plus Plan"
                            }
                        ]
                    }
                }
            }
        ]
    },
    "issues": [
        {
            "level": "error",
            "message": "Life open enrollment start date is 2021-08-01 in carrier system"
        },
        {
            "level": "error",
            "message": "LTD Plan not available yet in carrier system"
        }
    ]
}

Returns a renewal decision by ID.

Path Parameters

group_id The unique identifier of the group for which you are retrieving a renewal decision
renewal_decision_id The unique identifier of the renewal decision you want to retrieve

Get Renewal Decisions by ID Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
status* string The status on whether or not the renewal decision matches the carrier system. One of: not_ready, ready, submitted
group_id* uuid Group ID for the group related to the open enrollment period
renewal_date* date The renewal (start) date for this particular open enrollment period
body* object
  • carriers*:
    • carrier_id*: Unique identifier of the carrier in Noyo
    • lines_of_coverage:
      • medical:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans*:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • dental:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • vision:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • life:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • add:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • std:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • ltd:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • accident:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • critical_illness:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • cancer:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • hospital_indemnity:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
issues* array
  • level*: The level or severity of the issue found. One of: error, warning
  • message*: Message describing the issue found and any steps to resolve

Create Renewal Decisions

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/renewal_decisions

Body Parameter


{
    "renewal_date": "2022-01-01",
    "body": {
        "carriers": [
            {
                "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4",
                "lines_of_coverage": {
                    "medical": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468"
                            },
                            {
                                "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2"
                            },
                            {
                                "name": "Select Plus PPO HDHP Bronze BRJJ /C38"
                            }
                        ]
                    },
                    "dental": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "name": "Dental Plus Plan"
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Example Response

{
    "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6",
    "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e",
    "created": 1557862286,
    "modified": 1557862286,
    "status": "submitted",
    "group_id": "2c4d5515-6bf8-4f8c-821a-9c56374198b2",
    "renewal_date": "2022-01-01",
    "body": {
        "carriers": [
            {
                "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4",
                "lines_of_coverage": {
                    "medical": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468",
                                "name": "Select Plus PPO HDHP Gold BRJJ /C38"
                            },
                            {
                                "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2",
                                "name": "Select Plus PPO HDHP Silver BRJJ /C38"
                            },
                            {
                                "plan_id": "19437852-3795-4cb4-939c-a86543eabee0",
                                "name": "Select Plus PPO HDHP Bronze BRJJ /C38"
                            }
                        ]
                    },
                    "dental": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "44bc0f4a-0a94-11ec-9a03-0242ac130003",
                                "name": "Dental Plus Plan"
                            }
                        ]
                    }
                }
            }
        ]
    },
    "issues": []
}

Create a new renewal decision for a given renewal date.

Path Parameters

group_id The unique identifier of the group for which you are creating a new renewal decision

Request Body

renewal_date* date The renewal (start) date for this particular open enrollment period
body* object
  • carriers*:
    • carrier_id*: Unique identifier of the carrier in Noyo
    • lines_of_coverage:
      • medical:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans*:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • dental:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • vision:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • life:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • add:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • std:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • ltd:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • accident:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • critical_illness:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • cancer:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • hospital_indemnity:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan

Create Renewal Decisions Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
status* string The status on whether or not the renewal decision matches the carrier system. One of: not_ready, ready, submitted
group_id* uuid Group ID for the group related to the open enrollment period
renewal_date* date The renewal (start) date for this particular open enrollment period
body* object
  • carriers*:
    • carrier_id*: Unique identifier of the carrier in Noyo
    • lines_of_coverage:
      • medical:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans*:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • dental:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • vision:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • life:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • add:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • std:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • ltd:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • accident:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • critical_illness:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • cancer:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • hospital_indemnity:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
issues* array
  • level*: The level or severity of the issue found. One of: error, warning
  • message*: Message describing the issue found and any steps to resolve

Edit Renewal Decisions

Code Sample

curl -X PUT
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/renewal_decisions/4093a441-d4c8-4c8a-24d1-e7a132fb1bc2/d012e6ac-05dd-4cbe-8666-940af78c9e56

Body Parameter


{
    "renewal_date": "2022-01-01",
    "body": {
        "carriers": [
            {
                "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4",
                "lines_of_coverage": {
                    "medical": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468"
                            },
                            {
                                "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2"
                            },
                            {
                                "name": "Select Plus PPO HDHP Bronze BRJJ /C38"
                            }
                        ]
                    },
                    "dental": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "name": "Dental Plus Plan"
                            }
                        ]
                    }
                }
            }
        ]
    }
}

Example Response

{
    "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6",
    "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e",
    "created": 1557862286,
    "modified": 1557862286,
    "status": "submitted",
    "group_id": "2c4d5515-6bf8-4f8c-821a-9c56374198b2",
    "renewal_date": "2022-01-01",
    "body": {
        "carriers": [
            {
                "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4",
                "lines_of_coverage": {
                    "medical": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468",
                                "name": "Select Plus PPO HDHP Gold BRJJ /C38"
                            },
                            {
                                "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2",
                                "name": "Select Plus PPO HDHP Silver BRJJ /C38"
                            },
                            {
                                "plan_id": "19437852-3795-4cb4-939c-a86543eabee0",
                                "name": "Select Plus PPO HDHP Bronze BRJJ /C38"
                            }
                        ]
                    },
                    "dental": {
                        "open_enrollment_start_date": "2022-01-01",
                        "open_enrollment_end_date": "2022-01-31",
                        "plans": [
                            {
                                "plan_id": "44bc0f4a-0a94-11ec-9a03-0242ac130003",
                                "name": "Dental Plus Plan"
                            }
                        ]
                    }
                }
            }
        ]
    },
    "issues": []
}

Edit an existing renewal decision for a group.

Path Parameters

renewal_decision_id The unique identifier of the renewal decision you want to edit
version The unique identifier of the renewal decision version you want to edit

Request Body

renewal_date date The renewal (start) date for this particular open enrollment period
body object
  • carriers*:
    • carrier_id*: Unique identifier of the carrier in Noyo
    • lines_of_coverage:
      • medical:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans*:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • dental:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • vision:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • life:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • add:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • std:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • ltd:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • accident:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • critical_illness:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • cancer:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • hospital_indemnity:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan

Edit Renewal Decisions Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
status* string The status on whether or not the renewal decision matches the carrier system. One of: not_ready, ready, submitted
group_id* uuid Group ID for the group related to the open enrollment period
renewal_date* date The renewal (start) date for this particular open enrollment period
body* object
  • carriers*:
    • carrier_id*: Unique identifier of the carrier in Noyo
    • lines_of_coverage:
      • medical:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans*:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • dental:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • vision:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • life:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • add:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • std:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • ltd:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • accident:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • critical_illness:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • cancer:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
      • hospital_indemnity:
        • open_enrollment_start_date: ISO-8601 date string for the open enrollment start date for the line of coverage
        • open_enrollment_end_date: ISO-8601 date string for the open enrollment end date for the line of coverage
        • plans:
          • plan_id: Unique ID of a group plan that exists in the Noyo system
          • name: Name of the group plan
issues* array
  • level*: The level or severity of the issue found. One of: error, warning
  • message*: Message describing the issue found and any steps to resolve

Dropping Coverage

Use an empty object like the dental example below on a POST or a PUT to drop coverage

{
  "renewal_date": "2022-01-01",
  "body": {
    "carriers": [
      {
        "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1",
        "lines_of_coverage": {
          "medical": {
            "open_enrollment_start_date": "2021-07-01",
            "open_enrollment_end_date": "2021-08-31",
            "plans": [
              {
                "name": "Select Plus PPO HDHP Bronze BRJJ / C38"
              }
            ]
          }
        }
      },
      {
        "carrier_id": "6026ccdd-14e0-44dd-a68f-86b08cc89cf4",
        "lines_of_coverage": {
          "dental": {}
        }
      }
    ]
  }
}

To confirm that coverage is discontinued, and no plans will be active for an upcoming renewal, you can pass an empty block for that carrier and line of coverage.

Note that a completely omitted line of coverage will be ignored in the comparison with carrier data.

In this example response body, medical is interpreted as renewing with one plan. Dental coverage will be dropped by the group, while any current vision plan (or other line of coverage) will not be evaluated at all.

Open Enrollment

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/member_requests/open_enrollment

Body Parameter


{
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2020-01-15",
            "lines_of_coverage": {
                "medical": {
                    "adding_coverage": [
                        {
                            "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
                            "member_type": "dependent",
                            "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b",
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "request_type": "qualifying_life_event",
    "status": "processing",
    "transactions": [
        "579952dd-9a66-4587-a4f7-72a63bf9ec86"
    ],
    "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"
            }
        ]
    }
}

The open enrollment member request is used to make changes to existing employees, dependents and coverages during the open enrollment period.

Path Parameters

employee_id The unique identifier of the employee related to the member request

The coverages array contains one entry for each carrier with which you would like to make changes to coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. The lines_of_coverage object allows the following keys:

Key Description
accident Accident
add Accidental Death & Dismemberment
cancer Cancer
critical_illness Critical Illness
dental Dental
hospital_indemnity Hospital Indemnity
life Life
ltd Long Term Disability
medical Medical
std Short Term Disability
vision Vision

Signature Date

Within each entry in the coverages array you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Coverage Actions

Within each object inside of lines_of_coverage you may provide three different actions: adding_coverage, removing_coverage, and modifying_coverage. More information about each of these is below.

Adding Coverage

The adding_coverage action is used to add new coverage for a member with a carrier. You must provide an adding_coverage entry for each employee or dependent that is enrolling in coverage with the carrier along with the plan_id. The plan_id can be retrieved by selecting a valid plan from the group plans list.

Adding medical, dental, vision, accident, cancer or hospital_indemnity coverage

Medical, dental, vision, accident, cancer and hospital indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
prior_coverage object
  • carrier_name*: Name of insurance carrier providing prior coverage
  • last_coverage_date*: ISO-8601 date string of the last day of coverage with the prior insurance carrier

Adding life, add, std, ltd and critical_illness coverage

Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected
prior_coverage object
  • carrier_name*: Name of insurance carrier providing prior coverage
  • last_coverage_date*: ISO-8601 date string of the last day of coverage with the prior insurance carrier

Removing Coverage

The removing_coverage action is used to remove coverage from a member with a carrier. The structure of the removing_coverage action is below:

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member removing coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is removing or canceling coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

Modifying Coverage

The modifying_coverage action is used to make changes to an existing coverage for a member / plan combination, given that the member already has coverage on that plan with the carrier. For example, you can use the modifying_coverage action to change the volume of coverage for a member's existing life or disability plan, or provide a new carrier_config to remain on the same plan but move the member into a new subgroup or benefit class.

Modifying medical, dental, vision, accident, cancer or hospital_indemnity coverage

Medical, dental, vision, accident, cancer and hospital indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member modifying coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

Modifying life, add, std, ltd and critical_illness coverage

Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member modifying coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected

Open Enrollment Transactions

One or more open enrollment transactions will created based on the requested changes in the coverages array. For some carriers, there may be a single transaction including all of the requested changes, while other carriers may require separate transactions for each action type (i.e. one transaction per action per carrier).

Open Enrollment Member Transaction completed Result

Upon the successful completion of the transaction, the status of the member transaction will be updated and the result of the member transaction will be in the same format as the member request result.

New Hire Enrollment

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/72af10df-a8b3-46f1-a114-ac36d4b8a6ea/member_requests/new_hire

Body Parameter


{
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2020-01-15",
            "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"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
    "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
    "request_type": "new_hire",
    "status": "processing",
    "transactions": [
        "a6e30204-87b2-4802-95a4-a156bd0f7435"
    ],
    "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"
            }
        ]
    },
    "result": {}
}

The new hire member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers.

Path Parameters

employee_id The unique identifier of the employee related to the member request

Creating Employees and Dependents

Prior to adding an employee and dependent(s) to coverage, you should ensure they have been added to the API via the create employee and create dependent endpoints. Note: The hire_date of the employee will be sent to the carrier and the beginning of the coverage will be computed by the carrier according to the waiting period for the group.

The Coverages Object

The coverages array contains one entry for each carrier with which you would like to enroll or waive coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. The lines_of_coverage object allows the following keys:

Key Description
accident Accident
add Accidental Death & Dismemberment
cancer Cancer
critical_illness Critical Illness
dental Dental
hospital_indemnity Hospital Indemnity
life Life
ltd Long Term Disability
medical Medical
std Short Term Disability
vision Vision

Signature Date

Within each entry in the coverages array you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Enrolling Members

You must provide an enrolling_members entry for each employee or dependent that is enrolling in coverage with the carrier. The plan_id field is optional in each action. If you do not specify a plan_id, we will try to automatically select an available plan for the member based on the current group plans. When the group has more than one eligible plan for a member, you will need to specify the plan_id in the request. Plan IDs can be retrieved using the group plans endpoint.

Enrolling in medical, dental, vision, accident, cancer or hospital_indemnity

Medical, dental, vision, accident, cancer and hospital indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

Enrolling in life, add, std, ltd or critical_illness

Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected

Waiving Members

You can provide a waiving_members entry for each employee or dependent that is waiving coverage with the carrier along with the reason for waiving the coverage. This information will be communicated with the carrier where applicable. If you did not capture this information and only have the enrolling_members information the API request will still succeed.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member waiving coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is waiving coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

New Hire Member Request Result

Sample Request Result

{
    "dental": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }],
    "vision": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }]
}

Upon the successful completion of all the transactions in the new hire member request, the status of the member request will be updated to completed and the result of the member request will be an object with a key for each coverage (e.g. dental, vision) and an array with the following:

member_id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member for the member enrollment result. One of: dependent, employee
individual_enrollment_id* uuid Unique identifier of the individual enrollment in Noyo created by the member request

New Hire Transactions

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_transactions/a6e30204-87b2-4802-95a4-a156bd0f7435

Example Response

{
    "id": "a6e30204-87b2-4802-95a4-a156bd0f7435",
    "member_request_id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
    "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
    "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
    "lines_of_coverage": [
        "dental",
        "vision"
    ],
    "status": "processing",
    "type": "carrier_new_hire",
    "body": {
        "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"
                }]
            }
        }
    }
}

A new hire transaction is created for each entry in the coverages array (i.e. one transaction per carrier) with a type of carrier_new_hire.

New Hire Member Transaction completed Result

Upon the successful completion of the transaction, the status of the member transaction will be updated to completed and the result of the member transaction will be in the same format as the member request result

Qualifying Life Event

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/member_requests/qualifying_life_event

Body Parameter


{
    "event": {
        "event_type": "newborn",
        "event_date": "2020-01-01"
    },
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2020-01-15",
            "lines_of_coverage": {
                "medical": {
                    "adding_coverage": [
                        {
                            "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
                            "member_type": "dependent",
                            "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b",
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "request_type": "qualifying_life_event",
    "status": "processing",
    "transactions": [
        "579952dd-9a66-4587-a4f7-72a63bf9ec86"
    ],
    "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"
        }
    }
}

The qualifying life event member request is used to make changes to existing employees, dependents and coverages due to a qualifying life event.

Path Parameters

employee_id The unique identifier of the employee related to the member request

The Event Object

Each Qualifying Life Event requires an event parameter in the body which provides information about the type of the event as well as the date of its occurence. The schema for the event must follow this structure:

event_type* string Qualifying life event type. One of: adoption, change_to_full_time, change_to_part_time, court_order, death, dependent_open_enrollment, divorce, foster_care, immigration_status_change, legal_guardian, lost_coverage, marriage, medicare, moved, newborn, rate_changed, rehire, reinstatement
event_date* string ISO-8601 date string for qualifying life event date

The QLE Coverages Object

The coverages array contains one entry for each carrier with which you would like to make changes to coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. The lines_of_coverage object allows the following keys:

Key Description
accident Accident
add Accidental Death & Dismemberment
cancer Cancer
critical_illness Critical Illness
dental Dental
hospital_indemnity Hospital Indemnity
life Life
ltd Long Term Disability
medical Medical
std Short Term Disability
vision Vision

Signature Date

Within each entry in the coverages array you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Coverage Actions

Within each object inside of lines_of_coverage you may provide three different actions: adding_coverage, removing_coverage, and modifying_coverage. More information about each of these is below.

Adding Coverage

The adding_coverage action is used to add new coverage for a member with a carrier. You must provide an adding_coverage entry for each employee or dependent that is enrolling in coverage with the carrier. The plan_id field is optional in each action. If you do not specify a plan_id, we will try to automatically select an available plan for the member based on the current group plans. When the group has more than one eligible plan for a member, you will need to specify the plan_id in the request. Plan IDs can be retrieved using the group plans endpoint.

Adding medical, dental, vision, accident, cancer or hospital_indemnity coverage

Medical, dental, vision, accident, cancer and hospital indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
prior_coverage object
  • carrier_name*: Name of insurance carrier providing prior coverage
  • last_coverage_date*: ISO-8601 date string of the last day of coverage with the prior insurance carrier

Adding life, add, std, ltd or critical_illness coverage

Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected
prior_coverage object
  • carrier_name*: Name of insurance carrier providing prior coverage
  • last_coverage_date*: ISO-8601 date string of the last day of coverage with the prior insurance carrier

Removing Coverage

The removing_coverage action is used to remove coverage from a member with a carrier. The structure of the removing_coverage action is below:

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member removing coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is removing or canceling coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

Modifying Coverage

The modifying_coverage action is used to make changes to an existing coverage for a member / plan combination, given that the member already has coverage on that plan with the carrier. For example, you can use the modifying_coverage action to change the volume of coverage for a member's existing life or disability plan, or provide a new carrier_config to remain on the same plan but move the member into a new subgroup or benefit class.

Modifying medical, dental, vision, accident, cancer or hospital_indemnity coverage

Medical, dental, vision, accident, cancer and hospital_indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member modifying coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

Modifying life, add, std, ltd and critical_illness coverage

Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member modifying coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected

Qualifying Life Event Member Request Result

Sample Request Result

{
    "dental": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }],
    "vision": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }]
}

Upon the successful completion of all the transactions in the qualifying life event member request, the status of the member request will be updated to completed and the result of the member request will be an object with a key for each coverage (e.g. dental, vision) and an array with the following:

member_id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member for the member enrollment result. One of: dependent, employee
individual_enrollment_id* uuid Unique identifier of the individual enrollment in Noyo created by the member request

Qualifying Life Event Transactions

One or more qualifying life event transactions will created based on the requested changes in the coverages array. For some carriers, there may be a single transaction including all of the requested changes, while other carriers may require separate transactions for each action type (i.e. one transaction per action per carrier).

Qualifying Life Event Member Transaction completed Result

Upon the successful completion of the transaction, the status of the member transaction will be updated and the result of the member transaction will be in the same format as the member request result.

Termination

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/6dc22bed-27fc-458c-b732-bdaf5b5a1031/member_requests/termination

Body Parameter


{
    "reason": "voluntary",
    "last_work_date": "2020-01-15",
    "signature_date": "2020-01-01"
}

Example Response

{
    "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031",
    "request_type": "termination",
    "status": "processing",
    "transactions": [
        "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd"
    ],
    "body": {
        "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031",
        "last_work_date": "2020-01-15",
        "reason": "voluntary",
        "signature_date": "2020-01-01"
    }
}

The termination member request is used to remove an employee and their dependents from coverage at all carriers. The last_work_date will be communicated to the carrier and the last_day_of_coverage will be determined by the carrier and included in the result.

Path Parameters

employee_id The unique identifier of the employee related to the member request

Body Parameters

The member request for termination is straightforward and requires the following parameters in the body:

reason* string Reason for employee termination of coverage. One of: involuntary, job-eliminated, leave-of-absence, loss-of-eligibility, member-deceased, military-leave, voluntary
last_work_date* string ISO-8601 date string for last day of work of the terminated employee
signature_date string ISO-8601 date string for signature date

Signature Date

Within the termination request body you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system to the carrier as the signature_date.

Termination Transactions

A termination transaction is created for each carrier that the employee and dependents have coverage with a type of carrier_termination. A transaction is also created with the type noyo_termination. The noyo_termination transaction will complete on the last_work_date and will update the Employee object to be marked as terminated along with information about the last day of employment.

Carrier Termination Result

The result of the carrier_termination member transaction will include the last day that the members are covered at the carrier. The individual enrollments for the carrier will also be updated with a new status of terminated.

Sample Transaction Result

{
    "last_day_of_coverage": "2018-02-01"
}

Demographic Change

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/member_requests/demographic

Body Parameter


{
    "change_date": "2020-01-15",
    "signature_date": "2020-01-15",
    "member_changes": [
        {
            "member": {
                "id": "f471a562-fa8f-41c9-93fd-12b372e16c72",
                "type": "employee"
            },
            "name_change": {
                "first_name": "David",
                "last_name": "Williamson"
            },
            "contact_change": {
                "home_phone": "+15555551212",
                "work_phone": "+15555551212",
                "email_address": "david.williamson@example.com",
                "email_address_type": "home"
            },
            "salary_change": {
                "amount": 55000,
                "unit": "annual",
                "type": "salary"
            }
        }
    ]
}

Example Response

{
    "id": "db6f362a-9f90-49b2-a73d-830cd2726537",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "request_type": "demographic",
    "status": "processing",
    "transactions": [
        "b56bfe70-2632-49e9-b269-1eaa36ed7fd6"
    ],
    "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"
    }
}

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.

Path Parameters

employee_id The unique identifier of the employee related to the member request

Demographic Change Member Request Body

change_date string ISO-8601 date string for effective date of demographic change
signature_date string ISO-8601 date string for signature date
member_changes* array
  • member*:
    • id*: Unique identifier of the employee or dependent in Noyo
    • type*: Type of member making a demographic request. One of: dependent, employee
  • name_change:
    • first_name*: New first name of the person
    • middle_name: New middle name of the person
    • last_name*: New last name of the person
    • suffix: New name suffix of the person
  • address_change:
    • home_address:
      • street_one*: Line one of the new address
      • street_two: Line two of the new address
      • city*: City of the new address
      • state*: State postal code of the new address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • zip_code*: Zip code of the new address
      • county: County of the new address
    • mailing_address:
      • street_one*: Line one of the new address
      • street_two: Line two of the new address
      • city*: City of the new address
      • state*: State postal code of the new address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • zip_code*: Zip code of the new address
      • county: County of the new address
  • contact_change:
    • home_phone: New home phone number in E.164 format
    • work_phone: New work phone number in E.164 format
    • email_address: New email address of the person
    • email_address_type: Type of new email address. One of: home, work
  • ssn_change:
    • ssn*: New or corrected Social Security Number of the person
  • dob_change:
    • date_of_birth*: ISO-8601 date string for the new or corrected date of birth of the person
  • sex_change:
    • sex*: New sex of the person. One of: F, M
  • employment_change:
    • hire_date: ISO-8601 date string for the new or corrected hire date of the employee
    • employment_status: New or updated employee employment status. One of: contract, disabled, full-time, part-time, retired, terminated
    • occupation: New or updated employee occupation or job title
    • hours_worked: New number of hours worked per week by the employee
  • salary_change:
    • amount*: New or updated amount of salary earned by the employee in US dollars
    • unit*: New or updated unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
    • type*: New or updated type of salary earned by the employee. One of: hourly, salary

Demographic Change Member Request Result

Sample Request Result

[{
    "id": "f471a562-fa8f-41c9-93fd-12b372e16c72",
    "type" "employee",
    "version": "cf78e9b2-6213-448b-a0b9-04a254a84872"
}]

Upon the successful completion of all the transactions in the demographic change member request, the status of the member request will be updated to completed and the result of the member request will be an object containing an array of updated members. The employee and dependent objects in the Noyo API will be updated only when all transactions have completed.

COBRA Enrollment

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/72af10df-a8b3-46f1-a114-ac36d4b8a6ea/member_requests/cobra_enrollment

Body Parameter


{
    "termination_info": {
        "reason": "voluntary",
        "last_work_date": "2020-01-01"
    },
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2020-01-15",
            "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"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
    "request_type": "cobra_enrollment",
    "status": "processing",
    "transactions": [
        "a6e30204-87b2-4802-95a4-a156bd0f7435"
    ],
    "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"
        }
    },
    "result": {}
}

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.

Path Parameters

employee_id The unique identifier of the employee related to the member request

Termination Info

The termination_info block contains information about the termination of the employee prior to COBRA enrollment. If you have already sent a Termination Member Request for the employee the data from that request will be used. If you have not sent a Termination Member Request the data from this request will be used to terminate the member at the carrier.

reason* string Reason for employee termination of coverage. One of: involuntary, job-eliminated, leave-of-absence, loss-of-eligibility, member-deceased, military-leave, voluntary
last_work_date* string ISO-8601 date string for last day of work of the terminated employee

The Coverages Object

The coverages array contains one entry for each carrier with which you would like to enroll or waive coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. The lines_of_coverage object allows the following keys:

Key Description
accident Accident
add Accidental Death & Dismemberment
cancer Cancer
critical_illness Critical Illness
dental Dental
hospital_indemnity Hospital Indemnity
life Life
ltd Long Term Disability
medical Medical
std Short Term Disability
vision Vision

Signature Date

Within each entry in the coverages array you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Enrolling Members

You must provide an enrolling_members entry for each employee or dependent that is enrolling in coverage with the carrier. The plan_id field is optional in each action. If you do not specify a plan_id, we will try to automatically select an available plan for the member based on the current group plans. When the group has more than one eligible plan for a member, you will need to specify the plan_id in the request. Plan IDs can be retrieved using the group plans endpoint.

Enrolling in medical, dental, vision, accident, cancer or hospital_indemnity

Medical, dental, vision, accident, cancer and hospital indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

Enrolling in life, add, std, ltd or critical_illness

Life, AD&D, STD, LTD and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected

Waiving Members

You can provide a waiving_members entry for each employee or dependent that is waiving coverage with the carrier along with the reason for waiving the coverage. This information will be communicated with the carrier where applicable. If you did not capture this information and only have the enrolling_members information the API request will still succeed.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member waiving coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is waiving coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

Sample Request Result

{
    "dental": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }],
    "vision": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }]
}

Upon the successful completion of all the transactions in the member request, the status of the member request will be updated to completed and the result of the member request will be an object with a key for each coverage (e.g. dental, vision) and an array with the following:

member_id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member for the member enrollment result. One of: dependent, employee
individual_enrollment_id* uuid Unique identifier of the individual enrollment in Noyo created by the member request

COBRA Open Enrollment

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/member_requests/cobra_open_enrollment

Body Parameter


{
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2021-01-15",
            "lines_of_coverage": {
                "medical": {
                    "adding_coverage": [
                        {
                            "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
                            "member_type": "dependent",
                            "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "request_type": "cobra_open_enrollment",
    "status": "processing",
    "transactions": [
        "579952dd-9a66-4587-a4f7-72a63bf9ec86"
    ],
    "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"
            }
        ]
    }
}

The COBRA open enrollment member request is used to make changes to employees, dependents and COBRA coverages during the open enrollment period.

Path Parameters

employee_id The unique identifier of the employee related to the member request

The coverages array contains one entry for each carrier with which you would like to make changes to coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. The lines_of_coverage object allows the following keys for COBRA open enrollment:

Key Description
dental Dental
medical Medical
vision Vision

Signature Date

Within each entry in the coverages array you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Coverage Actions

Within each object inside of lines_of_coverage you may provide three different actions: adding_coverage, removing_coverage, and modifying_coverage. More information about each of these is below.

Adding Coverage

The adding_coverage action is used to add new coverage for a member with a carrier. You must provide an adding_coverage entry for each employee or dependent that is enrolling in coverage with the carrier along with the COBRA eligible plan_id. The plan_id can be retrieved by selecting a valid plan from the group plans list.

Adding medical, dental, or vision coverage

Medical, dental, and vision coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
prior_coverage object
  • carrier_name*: Name of insurance carrier providing prior coverage
  • last_coverage_date*: ISO-8601 date string of the last day of coverage with the prior insurance carrier

Removing Coverage

The removing_coverage action is used to remove coverage from a member with a carrier. The structure of the removing_coverage action is below:

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member removing coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is removing or canceling coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

Modifying Coverage

The modifying_coverage action is used to make changes to an existing coverage for a COBRA enrolled member / plan combination, given that the member already has COBRA coverage on that plan with the carrier. For example, you can use the modifying_coverage action to change the volume of coverage for a member's existing life or disability plan, or pass the same set of plans to remain on COBRA coverage with no changes.

Modifying medical, dental, or vision coverage

Medical, dental, and vision coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member modifying coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

COBRA Open Enrollment Transactions

One or more COBRA open enrollment transactions will created based on the requested changes in the coverages array. For some carriers, there may be a single transaction including all of the requested changes, while other carriers may require separate transactions for each action type (i.e. one transaction per action per carrier).

COBRA Open Enrollment Member Transaction completed Result

Upon the successful completion of the transaction, the status of the member transaction will be updated and the result of the member transaction will be in the same format as the member request result.

COBRA Qualifying Life Event

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/member_requests/cobra_qualifying_life_event

Body Parameter


{
    "event": {
        "event_type": "newborn",
        "event_date": "2021-01-01"
    },
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2021-01-15",
            "lines_of_coverage": {
                "medical": {
                    "adding_coverage": [
                        {
                            "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
                            "member_type": "dependent",
                            "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "request_type": "cobra_qualifying_life_event",
    "status": "processing",
    "transactions": [
        "579952dd-9a66-4587-a4f7-72a63bf9ec86"
    ],
    "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"
        }
    }
}

The COBRA qualifying life event member request is used to make changes to employees, dependents and COBRA coverages due to a qualifying life event.

Path Parameters

employee_id The unique identifier of the employee related to the member request

The Event Object

Each COBRA Qualifying Life Event requires an event parameter in the body which provides information about the type of the event as well as the date of its occurrence. The schema for the event must follow this structure:

event_type* string Qualifying life event type. One of: adoption, change_to_full_time, change_to_part_time, court_order, death, dependent_open_enrollment, divorce, foster_care, immigration_status_change, legal_guardian, lost_coverage, marriage, medicare, moved, newborn, rate_changed, rehire, reinstatement
event_date* string ISO-8601 date string for qualifying life event date

The COBRA QLE Coverages Object

The coverages array contains one entry for each carrier with which you would like to make changes to coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. For COBRA QLE requests, the lines_of_coverage object allows the following keys:

Key Description
dental Dental
medical Medical
vision Vision

Signature Date

Within each entry in the coverages array you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Coverage Actions

Within each object inside of lines_of_coverage you may provide three different actions: adding_coverage, removing_coverage, and modifying_coverage. More information about each of these is below.

Adding Coverage

The adding_coverage action is used to add new coverage for a member with a carrier. You must provide an adding_coverage entry for each employee or dependent that is enrolling in coverage with the carrier. The plan_id field is optional in each action. If you do not specify a plan_id, we will try to automatically select an available plan for the member based on the current group plans. When the group has more than one eligible plan for a member, you will need to specify the COBRA eligible plan_id in the request. Plan IDs can be retrieved using the group plans endpoint.

Adding medical, dental, or vision coverage

Medical, dental, and vision coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
prior_coverage object
  • carrier_name*: Name of insurance carrier providing prior coverage
  • last_coverage_date*: ISO-8601 date string of the last day of coverage with the prior insurance carrier

Removing Coverage

The removing_coverage action is used to remove coverage from a member with a carrier. The structure of the removing_coverage action is below:

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member removing coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is removing or canceling coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

Modifying Coverage

The modifying_coverage action is used to make changes to an existing coverage for a COBRA enrolled member / plan combination, given that the member already has COBRA coverage on that plan with the carrier. For example, you can use the modifying_coverage action to change the volume of coverage for a member's existing life or disability plan, or pass the same set of plans to remain on COBRA coverage with no changes.

Modifying medical, dental, or vision coverage

Medical, dental, and vision coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member modifying coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

COBRA Qualifying Life Event Member Request Result

Sample Request Result

{
    "dental": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }],
    "vision": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }]
}

Upon the successful completion of all the transactions in the COBRA qualifying life event member request, the status of the member request will be updated to completed and the result of the member request will be an object with a key for each coverage (e.g. dental, vision) and an array with the following:

member_id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member for the member enrollment result. One of: dependent, employee
individual_enrollment_id* uuid Unique identifier of the individual enrollment in Noyo created by the member request

COBRA Qualifying Life Event Transactions

One or more COBRA qualifying life event transactions will be created based on the requested changes in the coverages array. For some carriers, there may be a single transaction including all of the requested changes, while other carriers may require separate transactions for each action type (i.e. one transaction per action per carrier).

COBRA Qualifying Life Event Member Transaction completed Result

Upon the successful completion of the transaction, the status of the member transaction will be updated and the result of the member transaction will be in the same format as the member request result.

COBRA Termination

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/6dc22bed-27fc-458c-b732-bdaf5b5a1031/member_requests/cobra_termination

Body Parameter


{
    "reason": "voluntary",
    "cobra_termination_date": "2021-01-15",
    "signature_date": "2021-01-01"
}

Example Response

{
    "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031",
    "request_type": "cobra_termination",
    "status": "processing",
    "transactions": [
        "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd"
    ],
    "body": {
        "cobra_termination_date": "2021-01-15",
        "reason": "voluntary",
        "signature_date": "2021-01-01"
    }
}

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.

Path Parameters

employee_id The unique identifier of the employee related to the member request

Body Parameters

The member request for COBRA termination is straightforward and requires the following parameters in the body:

reason* string Reason the member has removed or canceled COBRA coverage. One of: expiration, involuntary, medicare-entitlement, new-enrollment, non-payment, voluntary
cobra_termination_date* string The COBRA Termination event date.
signature_date string ISO-8601 date string for signature date

Signature Date

Within the COBRA termination request body you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system to the carrier as the signature_date.

COBRA Termination Transactions

A COBRA termination transaction is created for each carrier that the employee and dependents have coverage with a type of carrier_cobra_termination.

Carrier COBRA Termination Result

The result of the carrier_cobra_termination member transaction will include the last day that the members are covered at the carrier. The individual enrollments for the carrier will also be updated with a new status of terminated.

Sample Transaction Result

{
    "last_day_of_coverage": "2018-02-01"
}

Enrollment Snapshot

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/72af10df-a8b3-46f1-a114-ac36d4b8a6ea/member_requests/enrollment_snapshot

Body Parameter


{
    "enrollment_type": "new_hire",
    "coverages": [
        {
            "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
            "carrier_config": {},
            "signature_date": "2020-01-15",
            "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"
                        }
                    ]
                }
            }
        }
    ]
}

Example Response

{
    "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
    "request_type": "enrollment_snapshot",
    "status": "processing",
    "transactions": [
        "a6e30204-87b2-4802-95a4-a156bd0f7435"
    ],
    "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"
    },
    "result": {}
}

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:

Path Parameters

employee_id The unique identifier of the employee related to the member request

The Coverages Object

The coverages array contains one entry for each carrier with which you would like to enroll or waive coverage. The carrier_id along with the schema of the carrier_config object will be provided by the Noyo team. You can reference the group carrier configuration resource to get additional carrier-specific data. The lines_of_coverage object allows the following keys:

Key Description
accident Accident
add Accidental Death & Dismemberment
cancer Cancer
critical_illness Critical Illness
dental Dental
hospital_indemnity Hospital Indemnity
life Life
ltd Long Term Disability
medical Medical
std Short Term Disability
vision Vision

Signature Date

Within each entry in the coverages array, you can optionally specify a signature_date. The signature_date is the date when the employee or employer signed for the change to be made. If a signature_date is not provided we will communicate the date the member request was received by the Noyo system as the signature_date to the carrier.

signature_date string ISO-8601 date string for signature date

Sending a Complete Snapshot

In order to send an Enrollment Snapshot, you will need to provide an election for every member + line of coverage combination on the policy. This is to prevent unintentional waiving of members from coverage. Below are two example scenarios:

Example 1

enrolling_members waiving_members
employee + medical dependent + dental
employee + vision dependent + vision
employee + dental
dependent + medical

Example 2

enrolling_members waiving_members
employee + medical
employee + vision
dependent + medical

Enrolling Members

You must provide an enrolling_members entry for each employee or dependent that is enrolling in coverage with the carrier. The plan_id field is optional in each action. If you do not specify a plan_id, we will try to automatically select an available plan for the member based on the current group plans. When the group has more than one eligible plan for a member, you will need to specify the plan_id in the request. Plan IDs can be retrieved using the group plans endpoint.

Enrolling in medical, dental, vision, accident, cancer, or hospital_indemnity

Medical, dental, vision, accident, cancer and hospital indemnity coverage do not require any information beyond the member information and the selected plan.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo

Enrolling in life, add, std, ltd or critical_illness

Life, AD&D, STD, LTD, and critical illness coverage also optionally accept volume parameter in dollars (e.g. $50,000 should be sent as 50000).

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member adding coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
volume integer Elected volume for the type of coverage being selected

Waiving Members

You can provide a waiving_members entry for each employee or dependent that is waiving coverage with the carrier along with the reason for waiving the coverage. This information will be communicated with the carrier where applicable. If you did not capture this information and only have the enrolling_members information the API request will still succeed.

id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member waiving coverage. One of: dependent, employee
plan_id uuid Unique identifier of the group plan in Noyo
reason* string Reason the member is waiving coverage. One of: medi-cal, medicaid, no-coverage, other-cobra, other-employee-group, other-ind-off-exchange, other-ind-on-exchange, other-medicare, other-parent-group, other-spouse-group, retiree-coverage, tricare-coverage, va-coverage, voluntary-withdrawal

Target Date

The target_date is an optional field, specified at the top level of the request. It can be used to designate the date on which the snapshot should take effect. This is only needed in the unlikely case where you would like the snapshot to take effect before a valid Qualifying Life Event or Open Enrollment member request that was received after the initial New Hire member request. An example would be:

  1. On 2019-12-15, you send an employee-only New Hire member request with a hire_date of 2019-12-05, which results in an employee with an effective_start_date of 2020-01-01.
  2. On 2020-02-05 you send a Qualifying Life Event member request to add a newborn child with event_date of 2020-02-01, such that the new dependent is covered as of 2020-02-01.
  3. On 2020-02-10 the employee changes their mind and would have liked their spouse on coverage from the beginning of their employment. To accomplish this change you should send an Enrollment Snapshot member request with a target_date of 2020-01-01 to get the spouse on coverage from 2020-01-01 to 2020-02-01.

Enrollment Snapshot Member Request Result

Sample Request Result

{
    "dental": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "ff033377-59e2-40df-8206-8cec3a725411"
    }],
    "vision": [{
        "member_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
        "member_type": "employee",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }, {
        "member_id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
        "member_type": "dependent",
        "individual_enrollment_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
    }]
}

Upon the successful completion of all the transactions in the Enrollment Snapshot member request, the status of the member request will be updated to completed and the result of the member request will be an object with a key for each coverage (e.g. dental, vision) and an array with the following:

member_id* uuid Unique identifier of the employee or dependent in Noyo
member_type* string Type of member for the member enrollment result. One of: dependent, employee
individual_enrollment_id* uuid Unique identifier of the individual enrollment in Noyo created by the member request

Member Premiums

Returns a premium amount billed to members for coverage with a carrier.

Premium Breakdown

Callers can query the API by employee ID to retrieve a list of member premiums associated with an employee and their family unit. The size of the response list will depend on the granularity of data made available by the carrier.

For example, if an employee is enrolled in dental and vision coverage and we know the exact cost split between each line of coverage, the response list would contain two member premium records, one with the dental amount and a single billed_members entry for the employee + dental plan, and one with the vision amount and a single billed_members entry for the employee + vision plan.

On the other hand, if we only know the total combined cost for both coverages, the response list would contain one member premium record with the total amount and two billed_members entries, one for the employee + dental plan and one for the employee + vision plan.

By Employee

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/premiums

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 2
    },
    "response": [
        {
            "carrier_id": "e2c76400-b505-432a-a1c1-c777bcec4648",
            "amount": "50.00",
            "period": {
                "amount": 1,
                "unit": "month"
            },
            "premium_type": "employer_amount",
            "effective_start_date": "2020-01-01",
            "effective_end_date": "2020-12-31",
            "billed_members": [
                {
                    "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
                    "member_type": "employee",
                    "line_of_coverage": "dental",
                    "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
                },
                {
                    "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
                    "member_type": "employee",
                    "line_of_coverage": "vision",
                    "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
                },
                {
                    "member_id": "67309c4b-12f5-4bb0-92ce-a45639af9055",
                    "member_type": "dependent",
                    "line_of_coverage": "dental",
                    "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
                },
                {
                    "member_id": "8f5aaf65-c4e6-4909-9ebf-58b320645df2",
                    "member_type": "dependent",
                    "line_of_coverage": "vision",
                    "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
                }
            ],
            "created": 1599184829,
            "modified": 1599292817
        },
        {
            "carrier_id": "e2c76400-b505-432a-a1c1-c777bcec4648",
            "amount": "50.00",
            "period": {
                "amount": 1,
                "unit": "month"
            },
            "premium_type": "employee_amount",
            "effective_start_date": "2020-01-01",
            "effective_end_date": "2020-12-31",
            "billed_members": [
                {
                    "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
                    "member_type": "employee",
                    "line_of_coverage": "dental",
                    "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
                },
                {
                    "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3",
                    "member_type": "employee",
                    "line_of_coverage": "vision",
                    "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
                },
                {
                    "member_id": "67309c4b-12f5-4bb0-92ce-a45639af9055",
                    "member_type": "dependent",
                    "line_of_coverage": "dental",
                    "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea"
                },
                {
                    "member_id": "8f5aaf65-c4e6-4909-9ebf-58b320645df2",
                    "member_type": "dependent",
                    "line_of_coverage": "vision",
                    "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0"
                }
            ],
            "created": 1599184829,
            "modified": 1599292817
        }
    ]
}

Returns list of Member Premium information for an employee and dependents

Path Parameters

employee_id Unique ID of the employee in Noyo

Query Parameters

effective_date The relative date on which to view the state of the records. Defaults to today

Member Premium List

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the record in Noyo
  • version*: Current version of the record
  • carrier_id*: Unique ID of the carrier in Noyo
  • amount*: Total amount of the premium in USD
  • period*:
    • amount*: Length of premium period
    • unit*: Unit frequency of premium period. One of: annual, day, month, semi-monthly, week
  • premium_type*: Premium type, either the total premium, or just the employer-paid or employee-paid portion. One of: employee_amount, employer_amount, total_amount
  • effective_start_date*: ISO-8601 date string for the effective start date of the premium
  • effective_end_date: ISO-8601 date string for the effective end date of the premium
  • billed_members*:
    • member_id*: Unique ID of the billed member in Noyo
    • member_type*: Type of member for the billed premium. One of: dependent, employee
    • line_of_coverage*: Line of coverage for the billed group plan. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
    • plan_id*: Unique identifier of the billed group plan in Noyo
  • created*: The date the record was created
  • modified*: The date the record was last updated

Verified Member Transactions

Often member transactions are sent in advance and will become effective at a date in the future (e.g, a new_hire member request with a hire_date of today, but the coverage does not start until the first of next month). Noyo works with carriers to verify that transactions have taken effect as expected and will mark the member transaction as verified when applicable. The verified field is the Unix time at which the member transaction was verified. You can expect the following timelines for verification at most carriers:

Transaction Type Timeline
New Hire On or shortly after the effective_start_date of the created individual enrollments
Termination On or shortly after the last_day_of_coverage
Qualifying Life Event On or shortly after the effective date of coverage changes
Open Enrollment On or shortly after the effective date of coverage changes
Demographic Change Immediately after completion of the member transaction

Member transactions and requests in the completed status require no additional attention or action from you. Think of verified transactions as ones where we were able to do a successful double check that everything went as we expected.

Note: There may be some cases where the carrier does not support verification. If the carrier supports verification and the member transaction does not verify in a timely manner we will notify you.

Getting Member Requests

Get Single Member Request

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_requests/dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1

Example Response

{
    "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
    "created": 1557512389,
    "modified": 1564440756,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "request_type": "termination",
    "status": "processing",
    "transactions": [
        "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd"
    ],
    "body": {
        "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031",
        "last_work_date": "2018-01-15",
        "reason": "voluntary"
    }
}

Returns the latest version of a single member request based on the ID provided.

Path Parameters

request_id The unique identifier of the member request you would like to view

Get Single Member Request Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
employee_id* uuid Unique identifier of the employee in Noyo
request_type* string Transaction type for the member request. One of: cobra_enrollment, cobra_open_enrollment, cobra_qualifying_life_event, cobra_termination, demographic, enrollment_snapshot, new_hire, open_enrollment, qualifying_life_event, termination
status* string Status of the member request. One of: canceled, completed, failed, processing
transactions array List of unique identifiers of all associated member transactions in Noyo
body* object Data required to execute a member request, varies depending on the request type
result* object Result from executing the member request, varies depending on the request type

For more information about the body and result fields check out the request-specific documentation

Get Member Requests for Employee

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/member_requests

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 2
    },
    "response": [
        {
            "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
            "created": 1557512389,
            "modified": 1564440756,
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "request_type": "new_hire",
            "status": "processing",
            "transactions": [
                "a6e30204-87b2-4802-95a4-a156bd0f7435"
            ],
            "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"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        },
        {
            "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "request_type": "termination",
            "status": "processing",
            "transactions": [
                "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd"
            ],
            "body": {
                "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031",
                "last_work_date": "2018-01-15",
                "reason": "voluntary"
            }
        }
    ]
}

Returns a list of all member requests for a given employee. Each member request may have one or more associated member transactions.

Path Parameters

employee_id The unique identifier of the employee for which you would like to view member requests

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get All Member Requests

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_requests

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 2
    },
    "response": [
        {
            "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
            "created": 1557512389,
            "modified": 1564440756,
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "request_type": "new_hire",
            "status": "processing",
            "transactions": [
                "a6e30204-87b2-4802-95a4-a156bd0f7435"
            ],
            "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"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        },
        {
            "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1",
            "created": 1557512389,
            "modified": 1564440756,
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "request_type": "termination",
            "status": "processing",
            "transactions": [
                "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd"
            ],
            "body": {
                "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031",
                "last_work_date": "2018-01-15",
                "reason": "voluntary"
            }
        }
    ]
}

Returns a list of all member requests for a given organization. Each member request may have one or more associated member transactions.

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
employee_id Unique identifier of the employee in Noyo for which you would like to filter
status The member request status for which you would like to filter
request_type The member request type for which you would like to filter

Get All Member Requests Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the record in Noyo
  • version*: Current version of the record
  • created*: The date the record was created
  • modified*: The date the record was last updated
  • employee_id*: Unique identifier of the employee in Noyo
  • request_type*: Transaction type for the member request. One of: cobra_enrollment, cobra_open_enrollment, cobra_qualifying_life_event, cobra_termination, demographic, enrollment_snapshot, new_hire, open_enrollment, qualifying_life_event, termination
  • status*: Status of the member request. One of: canceled, completed, failed, processing
  • transactions: List of unique identifiers of all associated member transactions in Noyo
  • body*: Data required to execute a member request, varies depending on the request type
  • result*: Result from executing the member request, varies depending on the request type

Filtering Member Requests

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_requests?status=processing&request_type=new_hire

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "request_type": "new_hire",
            "status": "processing",
            "transactions": [
                "a6e30204-87b2-4802-95a4-a156bd0f7435"
            ],
            "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"
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    ]
}

For cases where you would like to filter the Member Requests for you organization, you can do so by passing in one or more of the filters below into the query string.

employee_id uuid Unique identifier of the employee in Noyo to be filtered on
group_id uuid Unique identifier of the group in Noyo to be filtered on
status string Status of the member request to be filtered on. One of: canceled, completed, failed, processing
request_type string Member request type to be filtered on. One of: cobra_enrollment, cobra_open_enrollment, cobra_qualifying_life_event, cobra_termination, demographic, enrollment_snapshot, new_hire, open_enrollment, qualifying_life_event, termination

Getting Member Transactions

Get Single Member Transaction

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_transactions/a6e30204-87b2-4802-95a4-a156bd0f7435

Example Response

{
    "id": "a6e30204-87b2-4802-95a4-a156bd0f7435",
    "created": 1557512389,
    "modified": 1564440756,
    "member_request_id": "bba6ea27-4004-4a52-a3d9-f986ace0d3da",
    "employee_id": "25434576-e85d-481b-a825-962fd575046f",
    "carrier_id": "478e066e-9696-490e-b60f-47f40c96dc7c",
    "lines_of_coverage": [
        "medical",
        "dental",
        "vision"
    ],
    "status": "processing",
    "body": {
        "coverages": [
            {
                "carrier_config": {
                    "bill_group": "1000001",
                    "member_group": "99999"
                },
                "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16",
                "lines_of_coverage": {
                    "dental": {
                        "enrolling_members": [
                            {
                                "id": "25434576-e85d-481b-a825-962fd575046f",
                                "member_type": "employee",
                                "plan_id": "2e6a04b6-21f3-40d7-a9e2-735196cc451b"
                            }
                        ],
                        "waiving_members": []
                    },
                    "medical": {
                        "enrolling_members": [
                            {
                                "id": "25434576-e85d-481b-a825-962fd575046f",
                                "member_type": "employee",
                                "plan_id": "1873df52-c9e9-4e3a-995c-f47f32d0bd62"
                            }
                        ],
                        "waiving_members": []
                    },
                    "vision": {
                        "enrolling_members": [
                            {
                                "id": "25434576-e85d-481b-a825-962fd575046f",
                                "member_type": "employee",
                                "plan_id": "9cb64800-022e-40af-ab80-8d945e430592"
                            }
                        ],
                        "waiving_members": []
                    }
                }
            }
        ]
    }
}

Returns the latest version of a single member transaction based on the ID provided.

Path Parameters

transaction_id The unique identifier of the member transaction you would like to view

Get Single Member Transaction Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
member_request_id* uuid Unique identifier of the member request in the Noyo system
employee_id* uuid Unique identifier of the associated employee in the Noyo system
carrier_id uuid Unique identifier of the carrier in the Noyo system
lines_of_coverage* array List of lines of coverage for the member transaction. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
transaction_type* string Transaction type of the member transaction. One of: carrier_cobra_enrollment, carrier_cobra_open_enrollment, carrier_cobra_qualifying_life_event, carrier_cobra_termination, carrier_demographic, carrier_demographic_full, carrier_enrollment_snapshot_new_hire, carrier_new_hire, carrier_open_enrollment_adding, carrier_open_enrollment_full, carrier_open_enrollment_modifying, carrier_open_enrollment_removing, carrier_qualifying_life_event_adding, carrier_qualifying_life_event_full, carrier_qualifying_life_event_modifying, carrier_qualifying_life_event_removing, carrier_termination, noyo_termination
status* string Status of the member transaction. One of: canceled, completed, failed, processing
verified timestamp The date the member transaction was verified
body* object Body of the member transaction
result* object Result of the member transaction

For more information about the body and result fields check out the request-specific documentation

Get Transactions for Request

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_requests/a6e30204-87b2-4802-95a4-a156bd0f7435/member_transactions

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "a6e30204-87b2-4802-95a4-a156bd0f7435",
            "created": 1557512389,
            "modified": 1564440756,
            "member_request_id": "bba6ea27-4004-4a52-a3d9-f986ace0d3da",
            "employee_id": "25434576-e85d-481b-a825-962fd575046f",
            "carrier_id": "478e066e-9696-490e-b60f-47f40c96dc7c",
            "lines_of_coverage": [
                "medical",
                "dental",
                "vision"
            ],
            "status": "processing",
            "body": {
                "coverages": [
                    {
                        "carrier_config": {
                            "bill_group": "1000001",
                            "member_group": "99999"
                        },
                        "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16",
                        "lines_of_coverage": {
                            "dental": {
                                "enrolling_members": [
                                    {
                                        "id": "25434576-e85d-481b-a825-962fd575046f",
                                        "member_type": "employee",
                                        "plan_id": "2e6a04b6-21f3-40d7-a9e2-735196cc451b"
                                    }
                                ],
                                "waiving_members": []
                            },
                            "medical": {
                                "enrolling_members": [
                                    {
                                        "id": "25434576-e85d-481b-a825-962fd575046f",
                                        "member_type": "employee",
                                        "plan_id": "1873df52-c9e9-4e3a-995c-f47f32d0bd62"
                                    }
                                ],
                                "waiving_members": []
                            },
                            "vision": {
                                "enrolling_members": [
                                    {
                                        "id": "25434576-e85d-481b-a825-962fd575046f",
                                        "member_type": "employee",
                                        "plan_id": "9cb64800-022e-40af-ab80-8d945e430592"
                                    }
                                ],
                                "waiving_members": []
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Returns a list of all member transactions for a given member request.

Path Parameters

request_id The unique identifier of the member request for which you would like to view member transaction

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get All Member Transactions

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/member_transactions

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "a6e30204-87b2-4802-95a4-a156bd0f7435",
            "created": 1557512389,
            "modified": 1564440756,
            "member_request_id": "bba6ea27-4004-4a52-a3d9-f986ace0d3da",
            "employee_id": "25434576-e85d-481b-a825-962fd575046f",
            "carrier_id": "478e066e-9696-490e-b60f-47f40c96dc7c",
            "lines_of_coverage": [
                "medical",
                "dental",
                "vision"
            ],
            "status": "processing",
            "body": {
                "coverages": [
                    {
                        "carrier_config": {
                            "bill_group": "1000001",
                            "member_group": "99999"
                        },
                        "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16",
                        "lines_of_coverage": {
                            "dental": {
                                "enrolling_members": [
                                    {
                                        "id": "25434576-e85d-481b-a825-962fd575046f",
                                        "member_type": "employee",
                                        "plan_id": "2e6a04b6-21f3-40d7-a9e2-735196cc451b"
                                    }
                                ],
                                "waiving_members": []
                            },
                            "medical": {
                                "enrolling_members": [
                                    {
                                        "id": "25434576-e85d-481b-a825-962fd575046f",
                                        "member_type": "employee",
                                        "plan_id": "1873df52-c9e9-4e3a-995c-f47f32d0bd62"
                                    }
                                ],
                                "waiving_members": []
                            },
                            "vision": {
                                "enrolling_members": [
                                    {
                                        "id": "25434576-e85d-481b-a825-962fd575046f",
                                        "member_type": "employee",
                                        "plan_id": "9cb64800-022e-40af-ab80-8d945e430592"
                                    }
                                ],
                                "waiving_members": []
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Returns a list of all member transactions

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
ids Comma-separated member transaction IDs you would like to view

Get All Member Transactions Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the record in Noyo
  • version*: Current version of the record
  • created*: The date the record was created
  • modified*: The date the record was last updated
  • member_request_id*: Unique identifier of the member request in the Noyo system
  • employee_id*: Unique identifier of the associated employee in the Noyo system
  • carrier_id: Unique identifier of the carrier in the Noyo system
  • lines_of_coverage*: List of lines of coverage for the member transaction. One or more of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
  • transaction_type*: Transaction type of the member transaction. One of: carrier_cobra_enrollment, carrier_cobra_open_enrollment, carrier_cobra_qualifying_life_event, carrier_cobra_termination, carrier_demographic, carrier_demographic_full, carrier_enrollment_snapshot_new_hire, carrier_new_hire, carrier_open_enrollment_adding, carrier_open_enrollment_full, carrier_open_enrollment_modifying, carrier_open_enrollment_removing, carrier_qualifying_life_event_adding, carrier_qualifying_life_event_full, carrier_qualifying_life_event_modifying, carrier_qualifying_life_event_removing, carrier_termination, noyo_termination
  • status*: Status of the member transaction. One of: canceled, completed, failed, processing
  • verified: The date the member transaction was verified
  • body*: Body of the member transaction
  • result*: Result of the member transaction

Groups

This object represents an insured group underneath your organization. You can retrieve it to view details such as the name of the group and the SIC code of the company.

Get Single Group

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9

Example Response

{
    "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "version": "6b72d72d-cc99-4df6-8152-7183e824c80c",
    "created": 1557512389,
    "modified": 1543215342,
    "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
    "name": "Test Company",
    "sic_code": "7371",
    "dba_name": "Test Corp",
    "federal_ein": "112222222"
}

Returns the latest version of a single group based on the ID provided.

Path Parameters

group_id The unique identifier of the group to be retrieved

Get Single Group Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
organization_id* uuid Unique identifier of the platform or broker organization in Noyo
name* string Name of the group
sic_code string SIC Code of the group
dba_name string DBA name for the company, if applicable
federal_ein string Federal Employer Identification Number for the company

Get Groups

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "version": "6b72d72d-cc99-4df6-8152-7183e824c80c",
            "created": 1557512389,
            "modified": 1543215342,
            "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e",
            "name": "Test Company",
            "sic_code": "7371",
            "dba_name": "Test Corp",
            "federal_ein": "112222222"
        }
    ]
}

Returns a list of all groups in the current user organization.

If you would like to search the groups list, you can use the company query param. It allows searches based on the group's name or dba_name values.

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
company This query param searches groups by name or dba_name values
group_ids Comma-separated list of requested UUID group IDs
carrier_id Used for filtering for a carrier-specific group ID. Filter by the Noyo carrier ID. Must be used with carrier_group_id
carrier_group_id Used for filtering for a carrier-specific group ID. Must be used with carrier_id








Filter for a carrier group ID

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups?carrier_id=3092866a-e3a7-4c6e-964c-2bc45dfe7ad0&carrier_group_id=OXNEMWQ4WkxoQ0oK

You can use the combination of a carrier_id and a carrier_group_id to filter for a carrier-specific group ID. This ID will depend on the carrier, but it will generally be a unique identifier for the group from the carrier's system.

Get Groups Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the record in Noyo
  • version*: Current version of the record
  • created*: The date the record was created
  • modified*: The date the record was last updated
  • organization_id*: Unique identifier of the platform or broker organization in Noyo
  • name*: Name of the group
  • sic_code: SIC Code of the group
  • dba_name: DBA name for the company, if applicable
  • federal_ein: Federal Employer Identification Number for the company

Get Group Carrier Configurations

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2705bb9f-3c90-4400-a4e7-0bc9d48e677c/carrier_configurations

Example Response

[
    {
        "group_id": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c",
        "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16",
        "configuration": {
            "bill_groups": [
                {
                    "bill_group_description": "All Members",
                    "bill_group_number": 10001,
                    "bill_group_status": "open"
                }
            ],
            "member_groups": [
                {
                    "member_group_key": 2613038,
                    "member_group_name": "MEMBERS A",
                    "member_group_status": "open"
                },
                {
                    "member_group_key": 2613037,
                    "member_group_name": "MEMBERS B",
                    "member_group_status": "open"
                }
            ],
            "policy_number": "9100084"
        }
    }
]

Certain carriers have custom data for each group such as billing group information. This endpoint can be used to retrieve carrier-specific configuration data.

Path Parameters

group_id The unique identifier of the group for which you would like to view carrier configurations.

Query Parameters

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

Group Carrier Configuration Object

group_id* uuid Unique identifier of the group in Noyo
carrier_id* uuid Unique identifier of the carrier in Noyo
configuration* object Carrier configuration details for the group

Get Single Contact

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/contacts/30b74a44-d5b1-4123-a7a4-6d3aec251ba4

Example Response

{
    "id": "c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e",
    "version": "ef3fef8d-4889-40f4-a0f8-377b9dd23d98",
    "created": 1557512389,
    "modified": 1543215342,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "first_name": "David",
    "last_name": "Smith",
    "title": "Chief People Officer",
    "email": "davidsmith@testcorp.com",
    "phone_number": "+14255551234",
    "types": [
        "company",
        "billing",
        "executive"
    ],
    "primary_contact": true
}

Returns the latest version of a single group contact based on the ID provided.

Path Parameters

group_id The unique identifier of the group the contact belongs to
contact_id The unique identifier of the contact to be retrieved

Get Single Contact Response

id* uuid Unique identifier of the group contact in Noyo
version* uuid Version of the group contact record
created* timestamp The date the record was originated
modified* timestamp The date the record was last updated
group_id* uuid Unique identifier of the group in Noyo
first_name string First name of the group contact
last_name string Last name of the group contact
title string Job title of the group contact
email string Work email address of the group contact
phone_number string Work phone number of the group contact in E.164 format
types* array List of contact types for the group contact. One of: billing, company, executive, online
primary_contact boolean True if contact is the primary contact for the group

Get Contacts

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/contacts

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 2
    },
    "response": [
        {
            "id": "c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e",
            "version": "6ba43c6e-69f2-435f-a126-8595a798eb52",
            "created": 1557512389,
            "modified": 1543215342,
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "first_name": "David",
            "last_name": "Smith",
            "title": "Chief People Officer",
            "email": "davidsmith@testcorp.com",
            "phone_number": "+14255551234",
            "types": [
                "company",
                "billing"
            ],
            "primary_contact": true
        },
        {
            "id": "7e3c1f14-e7e7-42b8-81d8-3fcd7bd7d418",
            "version": "88bfbe28-7f8b-4497-a50b-932ee3387b68",
            "created": 1557512389,
            "modified": 1543215342,
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "first_name": "Caroline",
            "last_name": "Johnson",
            "title": "VP of Human Resources",
            "email": "carolinejohnson@testcorp.com",
            "phone_number": "+14255551234",
            "types": [
                "executive"
            ],
            "primary_contact": false
        }
    ]
}

Returns a list of all group contacts for a given group.

Path Parameters

group_id The unique identifier of the group for which you would like to view contacts

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get Contacts Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the group contact in Noyo
  • version*: Version of the group contact record
  • created*: The date the record was originated
  • modified*: The date the record was last updated
  • group_id*: Unique identifier of the group in Noyo
  • first_name: First name of the group contact
  • last_name: Last name of the group contact
  • title: Job title of the group contact
  • email: Work email address of the group contact
  • phone_number: Work phone number of the group contact in E.164 format
  • types*: List of contact types for the group contact. One or more of: billing, company, executive, online
  • primary_contact: True if contact is the primary contact for the group

Get Single Location

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/locations/bd957820-4652-4ee7-8a3a-6413df21e28d

Example Response

{
    "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7",
    "created": 1557512389,
    "modified": 1543215342,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "address": {
        "street_one": "1234 Test Ln",
        "city": "San Francisco",
        "state": "CA",
        "zip_code": "94107",
        "county": "San Francisco"
    }
}

Returns the latest version of a single group location based on the ID provided.

Path Parameters

group_id The unique identifier of the group the location belongs to
location_id The unique identifier of the location to be retrieved

Single Location Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated
group_id* uuid Unique identifier of the group in Noyo
display_name* string Display name for the group location
address* object
  • street_one*: Line one of the address
  • street_two: Line two of the address
  • city*: City of the address
  • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
  • zip_code*: Zip code of the address
  • county: County of the address

Get Locations

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/locations

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 2
    },
    "response": [
        {
            "id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
            "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7",
            "created": 1557512389,
            "modified": 1543215342,
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "address": {
                "street_one": "1234 Test Ln",
                "city": "San Francisco",
                "state": "CA",
                "zip_code": "94107",
                "county": "San Francisco"
            }
        }
    ]
}

Returns a list of all group locations for a given group.

Path Parameters

group_id The unique identifier of the group for which you would like to view locations

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get Locations Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the record in Noyo
  • version*: Current version of the record
  • created*: The date the record was created
  • modified*: The date the record was last updated
  • group_id*: Unique identifier of the group in Noyo
  • display_name*: Display name for the group location
  • address*:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address

Get Latest Audit

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2ce3b54a-2535-4803-b218-e6b44081d418/audit_requests/latest

Example Response

{
    "group_id": "2ce3b54a-2535-4803-b218-e6b44081d418",
    "carrier_ids": [
        "8fac0992-933a-4743-8dab-0d606ef2569e"
    ],
    "completed_at": 1602609543
}

Noyo regularly audits each Group against the carrier(s) that the Group has coverage with in order to find updated data and potential mismatches. This endpoint returns metadata about the latest group audit request that was completed. If no group audits have been completed the completed_at timestamp will be the timestamp of when the group was created and the carrier_ids array will be empty.

Path Parameters

group_id The unique identifier of the associated group in Noyo

Query Parameters

carrier_id The unique identifier of the carrier for which you would like to view audit requests

Get Latest Audit Response

group_id* uuid Unique identifier of the associated group in Noyo
carrier_ids* array List of carrier IDs included in group audit
completed_at* timestamp The date the group audit request was completed

Employees

This object represents an employee within a group. It contains personal information about the employee including name, address, contact info, etc. as well as employment related information like salary, occupation and employment status.

Get Single Employee

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4

Example Response

{
    "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043",
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "person": {
        "first_name": "David",
        "last_name": "Johnson",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "1981-06-22",
        "ssn": "123456789",
        "sex": "M",
        "marital_status": "",
        "contact": {
            "home_phone": "+12065551234",
            "work_phone": "+12065559876",
            "email_address": "david@testemail.com",
            "email_address_type": "home",
            "preferred_method": "email"
        }
    },
    "employment": {
        "employment_status": "full-time",
        "occupation": "Senior Analyst",
        "hours_worked": 50,
        "salary": {
            "amount": 55000,
            "unit": "annual",
            "type": "salary"
        },
        "employment_dates": {
            "hire_date": "2014-12-10",
            "full_time_start": "2015-01-01"
        }
    }
}

Returns the latest version of a single employee based on the ID provided.

Path Parameters

employee_id The unique identifier of the employee you would like to view

Get Single Employee Response

id* uuid Unique identifier of the employee in Noyo
version* uuid Version of the employee record
created* timestamp The date the record was originated
modified* timestamp The date the record was last updated
group_id* uuid Unique identifier of the group in Noyo
location_id uuid Unique identifier of the employee group location in Noyo
person* object
  • first_name*: First name of the person
  • middle_name: Middle name of the person
  • last_name*: Last name of the person
  • suffix: Suffix of the person
  • home_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • mailing_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • ssn: Social Security Number of the person
  • sex*: Sex of the person. One of: F, M, U
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • maiden_name: Maiden name of the person (deprecated)
  • contact:
    • home_phone: Home phone number in E.164 format
    • work_phone: Work phone number in E.164 format
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • preferred_language: Preferred written or spoken language of the person
    • speaks_english: True if the person can speak or communicate in English
  • details:
    • tobacco:
      • user: True if the person uses tobacco of any kind
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
    • disability:
      • disabled: True if the member has a disability
      • reason: Description of the disability
      • communication: True if the disability impacts the ability to communicate or read
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • is_student: True if the person is a student
    • is_military: True if the person is in the military
employment* object
  • employment_status*: Employee employment status. One of: contract, disabled, full-time, part-time, retired, terminated
  • occupation: Employee occupation or job title
  • hours_worked*: An integer of hours worked per week by the employee
  • salary:
    • amount: Amount of salary earned by the employee in US dollars and cents, as a decimal value
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
    • type: Type of salary earned by the employee. One of: hourly, salary
  • employment_dates*:
    • hire_date: ISO-8601 date string for the hire date of the employee
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)

Get Employees in a Group

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/employees

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043",
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
            "person": {
                "first_name": "David",
                "last_name": "Johnson",
                "home_address": {
                    "street_one": "1234 Home Ave",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip_code": "94107",
                    "county": "San Francisco"
                },
                "date_of_birth": "1981-06-22",
                "ssn": "123456789",
                "sex": "M",
                "marital_status": "",
                "contact": {
                    "home_phone": "+12065551234",
                    "work_phone": "+12065559876",
                    "email_address": "david@testemail.com",
                    "email_address_type": "home",
                    "preferred_method": "email"
                }
            },
            "employment": {
                "employment_status": "full-time",
                "occupation": "Senior Analyst",
                "hours_worked": 50,
                "salary": {
                    "amount": 55000,
                    "unit": "annual",
                    "type": "salary"
                },
                "employment_dates": {
                    "hire_date": "2014-12-10",
                    "full_time_start": "2015-01-01"
                }
            }
        }
    ]
}

Returns a list of all employees for a given group.

Path Parameters

group_id The unique identifier of the group for which you would like to view employees

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
first_name The employee first name for which you would like to filter
last_name The employee last name for which you would like to filter
date_of_birth The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter

Get All Employees

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043",
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
            "person": {
                "first_name": "David",
                "last_name": "Johnson",
                "home_address": {
                    "street_one": "1234 Home Ave",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip_code": "94107",
                    "county": "San Francisco"
                },
                "date_of_birth": "1981-06-22",
                "ssn": "123456789",
                "sex": "M",
                "marital_status": "single",
                "contact": {
                    "home_phone": "+12065551234",
                    "work_phone": "+12065559876",
                    "email_address": "david@testemail.com",
                    "email_address_type": "home",
                    "preferred_method": "email"
                }
            },
            "employment": {
                "employment_status": "full-time",
                "occupation": "Senior Analyst",
                "hours_worked": 50,
                "salary": {
                    "amount": 55000,
                    "unit": "annual",
                    "type": "salary"
                },
                "employment_dates": {
                    "hire_date": "2014-12-10",
                    "full_time_start": "2015-01-01"
                }
            }
        }
    ]
}

If there is a use case where you need to query employees across all the groups in your organization you can do so using this endpoint. Returns a list of all employees under your organization, regardless of group.

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1
first_name The employee first name for which you would like to filter
last_name The employee last name for which you would like to filter
date_of_birth The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter

Get All Employees Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the employee in Noyo
  • version*: Version of the employee record
  • created*: The date the record was originated
  • modified*: The date the record was last updated
  • group_id*: Unique identifier of the group in Noyo
  • location_id: Unique identifier of the employee group location in Noyo
  • person*:
    • first_name*: First name of the person
    • middle_name: Middle name of the person
    • last_name*: Last name of the person
    • suffix: Suffix of the person
    • home_address:
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • city*: City of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • zip_code*: Zip code of the address
      • county: County of the address
    • mailing_address:
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • city*: City of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • zip_code*: Zip code of the address
      • county: County of the address
    • date_of_birth*: ISO-8601 date string for the date of birth of the person
    • ssn: Social Security Number of the person
    • sex*: Sex of the person. One of: F, M, U
    • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
    • maiden_name: Maiden name of the person (deprecated)
    • contact:
      • home_phone: Home phone number in E.164 format
      • work_phone: Work phone number in E.164 format
      • email_address: Email address of the person
      • email_address_type: Type of email address. One of: home, work
      • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
      • preferred_language: Preferred written or spoken language of the person
      • speaks_english: True if the person can speak or communicate in English
    • details:
      • tobacco:
        • user: True if the person uses tobacco of any kind
        • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
        • duration: Duration of tobacco use
        • frequency: Frequency of tobacco use
      • disability:
        • disabled: True if the member has a disability
        • reason: Description of the disability
        • communication: True if the disability impacts the ability to communicate or read
      • american_indian:
        • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
        • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
      • is_student: True if the person is a student
      • is_military: True if the person is in the military
  • employment*:
    • employment_status*: Employee employment status. One of: contract, disabled, full-time, part-time, retired, terminated
    • occupation: Employee occupation or job title
    • hours_worked*: An integer of hours worked per week by the employee
    • salary:
      • amount: Amount of salary earned by the employee in US dollars and cents, as a decimal value
      • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
      • type: Type of salary earned by the employee. One of: hourly, salary
    • employment_dates*:
      • hire_date: ISO-8601 date string for the hire date of the employee
      • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
      • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
      • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
      • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)

Filtering Employees in a Group

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/employees?first_name=Ann&last_name=Green

There may be some cases where you wish to find a specific employee in a group, but do not know their Noyo id. We provide a way to filter your employee list for a given group via query parameters. The following parameters are accepted by the API in the query string:

first_name string First name of the employee to be filtered on
last_name string Last name of the employee to be filtered on
date_of_birth date ISO-8601 date string for the date of birth of the employee to be filtered on

The filtering is not case-sensitive and it does not require an exact match on the value (e.g. searching for "ann" will match against "Ann" as well as "Annie")

Filtering All Employees

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees?first_name=Ann&last_name=Green

There may be some cases where you wish to find a specific employee across all of your groups, but do not know their Noyo id. We provide a way to filter your employee list via query parameters. The following parameters are accepted by the API in the query string:

first_name string First name of the employee to be filtered on
last_name string Last name of the employee to be filtered on
date_of_birth date ISO-8601 date string for the date of birth of the employee to be filtered on

The filtering is not case-sensitive and it does not require an exact match on the value (e.g. searching for "ann" will match against "Ann" as well as "Annie")

Create Employee

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees

Body Parameter


{
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "person": {
        "first_name": "David",
        "last_name": "Johnson",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "1981-06-22",
        "ssn": "123456789",
        "sex": "M",
        "marital_status": "married",
        "contact": {
            "home_phone": "+12065551234",
            "work_phone": "+12065559876",
            "email_address": "david@testemail.com",
            "email_address_type": "home",
            "preferred_method": "email"
        }
    },
    "employment": {
        "employment_status": "full-time",
        "occupation": "Senior Analyst",
        "hours_worked": 50,
        "salary": {
            "amount": 55000,
            "unit": "annual",
            "type": "salary"
        },
        "employment_dates": {
            "hire_date": "2014-12-10",
            "full_time_start": "2015-01-01"
        }
    }
}

Example Response

{
    "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043",
    "created": 1626281253,
    "modified": 1626281253,
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
    "person": {
        "first_name": "David",
        "last_name": "Johnson",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "1981-06-22",
        "ssn": "123456789",
        "sex": "M",
        "marital_status": "married",
        "contact": {
            "home_phone": "+12065551234",
            "work_phone": "+12065559876",
            "email_address": "david@testemail.com",
            "email_address_type": "home",
            "preferred_method": "email"
        }
    },
    "employment": {
        "employment_status": "full-time",
        "occupation": "Senior Analyst",
        "hours_worked": 50,
        "salary": {
            "amount": 55000,
            "unit": "annual",
            "type": "salary"
        },
        "employment_dates": {
            "hire_date": "2014-12-10",
            "full_time_start": "2015-01-01"
        }
    }
}

Create a new employee for a group.

Request Body

group_id* uuid Unique identifier of the group in Noyo
location_id uuid Unique identifier of the employee group location in Noyo
person* object
  • first_name*: First name of the person
  • middle_name: Middle name of the person
  • last_name*: Last name of the person
  • suffix: Suffix of the person
  • home_address*:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • mailing_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • ssn: Social Security Number of the person
  • sex*: Sex of the person. One of: F, M
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • maiden_name: Maiden name of the person (deprecated)
  • contact:
    • home_phone: Home phone number in E.164 format
    • work_phone: Work phone number in E.164 format
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • preferred_language: Preferred written or spoken language of the person
    • speaks_english: True if the person can speak or communicate in English
  • details:
    • tobacco:
      • user: True if the person uses tobacco of any kind
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
    • disability:
      • disabled: True if the member has a disability
      • reason: Description of the disability
      • communication: True if the disability impacts the ability to communicate or read
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • is_student: True if the person is a student
    • is_military: True if the person is in the military
employment* object
  • employment_status*: Employee employment status. One of: contract, disabled, full-time, part-time, retired, terminated
  • occupation: Employee occupation or job title
  • hours_worked*: An integer of hours worked per week by the employee
  • salary:
    • amount: Amount of salary earned by the employee in US dollars and cents, as a decimal value
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
    • type: Type of salary earned by the employee. One of: hourly, salary
  • employment_dates*:
    • hire_date*: ISO-8601 date string for the hire date of the employee
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)

Create Employee Response

id* uuid Unique identifier of the employee in Noyo
version* uuid Version of the employee record
created* timestamp The date the record was originated
modified* timestamp The date the record was last updated
group_id* uuid Unique identifier of the group in Noyo
location_id uuid Unique identifier of the employee group location in Noyo
person* object
  • first_name*: First name of the person
  • middle_name: Middle name of the person
  • last_name*: Last name of the person
  • suffix: Suffix of the person
  • home_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • mailing_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • ssn: Social Security Number of the person
  • sex*: Sex of the person. One of: F, M, U
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • maiden_name: Maiden name of the person (deprecated)
  • contact:
    • home_phone: Home phone number in E.164 format
    • work_phone: Work phone number in E.164 format
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • preferred_language: Preferred written or spoken language of the person
    • speaks_english: True if the person can speak or communicate in English
  • details:
    • tobacco:
      • user: True if the person uses tobacco of any kind
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
    • disability:
      • disabled: True if the member has a disability
      • reason: Description of the disability
      • communication: True if the disability impacts the ability to communicate or read
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • is_student: True if the person is a student
    • is_military: True if the person is in the military
employment* object
  • employment_status*: Employee employment status. One of: contract, disabled, full-time, part-time, retired, terminated
  • occupation: Employee occupation or job title
  • hours_worked*: An integer of hours worked per week by the employee
  • salary:
    • amount: Amount of salary earned by the employee in US dollars and cents, as a decimal value
    • unit: Unit of salary earned by the employee. One of: annual, hour, month, semi-monthly, week
    • type: Type of salary earned by the employee. One of: hourly, salary
  • employment_dates*:
    • hire_date: ISO-8601 date string for the hire date of the employee
    • full_time_start: ISO-8601 date string for start date as a full time employee with the group (if applicable)
    • terminated: ISO-8601 date string for the termination date of the employee (if applicable)
    • rehire: ISO-8601 date string for the rehire date of the employee (if applicable)
    • retirement: ISO-8601 date string for the retirement date of the employee (if applicable)

Dependents

This object represents an employee's dependent. It contains personal information about the dependent including name, address, contact info, etc. along with the dependent's relationship to the employee.

Get Single Dependent

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/dependents/fd62665c-0846-4e9d-bd29-80779b5f685c

Example Response

{
    "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
    "version": "669fbe16-9960-4069-91aa-832ada3f4e42",
    "created": 1557512389,
    "modified": 1547412389,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "relationship": "spouse",
    "person": {
        "first_name": "Diane",
        "last_name": "Johnson",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "1982-01-02",
        "ssn": "987654321",
        "sex": "F",
        "marital_status": "married",
        "contact": {
            "home_phone": "+12065551234",
            "email_address": "diane@testemail.com",
            "email_address_type": "home"
        }
    }
}

Returns the latest version of a single dependent based on the ID provided.

Path Parameters

dependent_id The unique identifier of the dependent you would like to view

Get Single Dependent Response

id* uuid Unique identifier of the dependent in Noyo
version* uuid Version of the dependent record
created* timestamp The date the record was originated
modified* timestamp The date the record was last updated
employee_id* uuid Unique identifier of the employee in Noyo
relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
person* object
  • first_name*: First name of the person
  • middle_name: Middle name of the person
  • last_name*: Last name of the person
  • suffix: Suffix of the person
  • home_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • mailing_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • ssn: Social Security Number of the person
  • sex*: Sex of the person. One of: F, M, U
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • maiden_name: Maiden name of the person (deprecated)
  • contact:
    • home_phone: Home phone number in E.164 format
    • work_phone: Work phone number in E.164 format
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • preferred_language: Preferred written or spoken language of the person
    • speaks_english: True if the person can speak or communicate in English
  • details:
    • tobacco:
      • user: True if the person uses tobacco of any kind
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
    • disability:
      • disabled: True if the member has a disability
      • reason: Description of the disability
      • communication: True if the disability impacts the ability to communicate or read
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • is_student: True if the person is a student
    • is_military: True if the person is in the military

Get Dependents

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/dependents

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 1
    },
    "response": [
        {
            "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
            "version": "669fbe16-9960-4069-91aa-832ada3f4e42",
            "created": 1557512389,
            "modified": 1547412389,
            "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
            "relationship": "spouse",
            "person": {
                "first_name": "Diane",
                "last_name": "Johnson",
                "home_address": {
                    "street_one": "1234 Home Ave",
                    "city": "San Francisco",
                    "state": "CA",
                    "zip_code": "94107",
                    "county": "San Francisco"
                },
                "date_of_birth": "1982-01-02",
                "ssn": "987654321",
                "sex": "F",
                "marital_status": "",
                "contact": {
                    "home_phone": "+12065551234",
                    "email_address": "diane@testemail.com",
                    "email_address_type": "home"
                }
            }
        }
    ]
}

Returns a list of all dependents for a given employee.

Path Parameters

employee_id The unique identifier of the employee for which you would like to view dependents

Query Parameters

page_size The max size of each page of results
offset The integer offset at which to start the page. Possible values are 0 to total_records - 1

Get Dependents Response

meta* object
  • offset*: The offset of the first response record within the matching data set
  • page_num*: The page number of the response records within the overall data set (1-based integer)
  • page_size*: The maximum number of response records on each page of results
  • total_records*: The total number of records in the entire matching data set
response* array
  • id*: Unique identifier of the dependent in Noyo
  • version*: Version of the dependent record
  • created*: The date the record was originated
  • modified*: The date the record was last updated
  • employee_id*: Unique identifier of the employee in Noyo
  • relationship*: Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
  • person*:
    • first_name*: First name of the person
    • middle_name: Middle name of the person
    • last_name*: Last name of the person
    • suffix: Suffix of the person
    • home_address:
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • city*: City of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • zip_code*: Zip code of the address
      • county: County of the address
    • mailing_address:
      • street_one*: Line one of the address
      • street_two: Line two of the address
      • city*: City of the address
      • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • zip_code*: Zip code of the address
      • county: County of the address
    • date_of_birth*: ISO-8601 date string for the date of birth of the person
    • ssn: Social Security Number of the person
    • sex*: Sex of the person. One of: F, M, U
    • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
    • maiden_name: Maiden name of the person (deprecated)
    • contact:
      • home_phone: Home phone number in E.164 format
      • work_phone: Work phone number in E.164 format
      • email_address: Email address of the person
      • email_address_type: Type of email address. One of: home, work
      • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
      • preferred_language: Preferred written or spoken language of the person
      • speaks_english: True if the person can speak or communicate in English
    • details:
      • tobacco:
        • user: True if the person uses tobacco of any kind
        • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
        • duration: Duration of tobacco use
        • frequency: Frequency of tobacco use
      • disability:
        • disabled: True if the member has a disability
        • reason: Description of the disability
        • communication: True if the disability impacts the ability to communicate or read
      • american_indian:
        • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
        • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
      • is_student: True if the person is a student
      • is_military: True if the person is in the military

Create Dependent

Code Sample

curl -X POST
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/employees/30b74a44-d5b1-4123-a7a4-6d3aec251ba4/dependents

Body Parameter


{
    "relationship": "child",
    "person": {
        "first_name": "Jamie",
        "last_name": "Johnson",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "2000-01-02",
        "ssn": "384032999",
        "sex": "F",
        "marital_status": "single",
        "contact": {
            "home_phone": "+12065551234",
            "email_address": "jamie@testemail.com",
            "email_address_type": "home"
        }
    }
}

Example Response

{
    "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
    "version": "669fbe16-9960-4069-91aa-832ada3f4e42",
    "created": 1626281253,
    "modified": 1626281253,
    "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
    "relationship": "child",
    "person": {
        "first_name": "Jamie",
        "last_name": "Johnson",
        "home_address": {
            "street_one": "1234 Home Ave",
            "city": "San Francisco",
            "state": "CA",
            "zip_code": "94107",
            "county": "San Francisco"
        },
        "date_of_birth": "2000-01-02",
        "ssn": "384032999",
        "sex": "F",
        "marital_status": "single",
        "contact": {
            "home_phone": "+12065551234",
            "email_address": "jamie@testemail.com",
            "email_address_type": "home"
        }
    }
}

Create a new dependent for an employee.

Path Parameters

employee_id The unique identifier of the employee the dependent belongs to

Request Body

relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
person* object
  • first_name*: First name of the person
  • middle_name: Middle name of the person
  • last_name*: Last name of the person
  • suffix: Suffix of the person
  • home_address*:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • mailing_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • ssn: Social Security Number of the person
  • sex*: Sex of the person. One of: F, M
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • maiden_name: Maiden name of the person (deprecated)
  • contact:
    • home_phone: Home phone number in E.164 format
    • work_phone: Work phone number in E.164 format
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • preferred_language: Preferred written or spoken language of the person
    • speaks_english: True if the person can speak or communicate in English
  • details:
    • tobacco:
      • user: True if the person uses tobacco of any kind
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
    • disability:
      • disabled: True if the member has a disability
      • reason: Description of the disability
      • communication: True if the disability impacts the ability to communicate or read
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • is_student: True if the person is a student
    • is_military: True if the person is in the military

Create Dependent Response

id* uuid Unique identifier of the dependent in Noyo
version* uuid Version of the dependent record
created* timestamp The date the record was originated
modified* timestamp The date the record was last updated
employee_id* uuid Unique identifier of the employee in Noyo
relationship* string Relationship of the dependent to the employee. One of: adopted-child, child, civil-union, domestic-partner, ex-spouse, foster-child, grandchild, legal-guardianship, other, spouse, step-child
person* object
  • first_name*: First name of the person
  • middle_name: Middle name of the person
  • last_name*: Last name of the person
  • suffix: Suffix of the person
  • home_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • mailing_address:
    • street_one*: Line one of the address
    • street_two: Line two of the address
    • city*: City of the address
    • state*: State postal code of the address. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
    • zip_code*: Zip code of the address
    • county: County of the address
  • date_of_birth*: ISO-8601 date string for the date of birth of the person
  • ssn: Social Security Number of the person
  • sex*: Sex of the person. One of: F, M, U
  • marital_status: Marital status of the person. One of: divorced, domestic-partner, legally-separated, married, single, widowed
  • maiden_name: Maiden name of the person (deprecated)
  • contact:
    • home_phone: Home phone number in E.164 format
    • work_phone: Work phone number in E.164 format
    • email_address: Email address of the person
    • email_address_type: Type of email address. One of: home, work
    • preferred_method: Preferred method of contact for the person. One of: email, home-phone, mail, other, work-phone
    • preferred_language: Preferred written or spoken language of the person
    • speaks_english: True if the person can speak or communicate in English
  • details:
    • tobacco:
      • user: True if the person uses tobacco of any kind
      • types: List of types of tobacco use. One or more of: chewing-tobacco, cigarettes, pipe
      • duration: Duration of tobacco use
      • frequency: Frequency of tobacco use
    • disability:
      • disabled: True if the member has a disability
      • reason: Description of the disability
      • communication: True if the disability impacts the ability to communicate or read
    • american_indian:
      • state: Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable. One of: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UM, UT, VA, VI, VT, WA, WI, WV, WY
      • tribe: Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
    • is_student: True if the person is a student
    • is_military: True if the person is in the military

Group Enrollments

This object represents the unique relationship between a group, carrier, and line of coverage (e.g. medical, dental, vision).

Get Single Group Enrollment

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/group_enrollments/7499ea07-76c9-40f2-992b-952259e98384

Example Response

{
    "id": "7499ea07-76c9-40f2-992b-952259e98384",
    "version": "c2292b67-0382-45e9-a378-b52c4129f672",
    "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
    "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
    "line_of_coverage": "medical",
    "status": "active",
    "open_enrollment_start_date": "2019-01-01",
    "open_enrollment_end_date": "2019-02-01",
    "effective_start_date": "2019-01-01",
    "effective_end_date": "2019-12-31",
    "created": 1557512389,
    "modified": 1543215342
}

Returns the latest version of a single group enrollment based on the ID provided.

Path Parameters

enrollment_id Unique identifier of the group enrollment

Get Single Group Enrollment Response

id* uuid Unique identifier of the record in Noyo
version* uuid Current version of the record
group_id* uuid Unique identifier of the associated group in the Noyo system
carrier_id* uuid Unique identifier of the associated carrier in the Noyo system
line_of_coverage* string Line of coverage for the group enrollment. One of: accident, add, cancer, critical_illness, dental, hospital_indemnity, life, ltd, medical, std, vision
status* string Status of the group enrollment. One of: active, completed, pending
open_enrollment_start_date date ISO-8601 date string for the open enrollment start date of the group enrollment
open_enrollment_end_date date ISO-8601 date string for the open enrollment end date of the group enrollment
open_enrollment_renewal_date date ISO-8601 date string for the open enrollment renewal start date of the group enrollment
effective_start_date date ISO-8601 date string for the effective start date of the record
effective_end_date date ISO-8601 date string for the effective end date of the record
created* timestamp The date the record was created
modified* timestamp The date the record was last updated

Get Group Enrollments

Code Sample

curl -X GET
 --header "Authorization: Bearer <ACCESS_TOKEN>"
 https://fulfillment.noyo.com/api/v1/groups/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/group_enrollments

Example Response

{
    "meta": {
        "offset": 0,
        "page_num": 1,
        "page_size": 20,
        "total_records": 2
    },
    "response": [
        {
            "id": "7499ea07-76c9-40f2-992b-952259e98384",
            "version": "c2292b67-0382-45e9-a378-b52c4129f672",
            "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
            "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e",
            "line_of_coverage": "medical",
            "status": "active",
            "open_enrollment_start_date": "2019-01-01",
            "open_enrollment_end_date": "2019-02-01",
            "effective_start_date": "2019-01-01",
            "effective_end_date": "2019-12-31",
            "created": 1557512389,
            "modified"