​

Group connections

Create a group connection request to manage groups through Noyo. In the group_data object for the create endpoint, use the 7 digit VSP group ID (also called the master agreement number) for the carrier_group_id.

​

Sandbox testing

Use the following special VSP carrier_group_ids to simulate different group connection statuses. Test group connections with these IDs will asynchronously update with the corresponding status within 10 seconds of submission.

Only the first three characters are evaluated to figure out the target status (e.g. 989 means noyo_review). Since group connections should be unique by a carrier ID and carrier group ID combination, you may use the final characters to iterate and test this interaction further.

​

Carrier configurations

Group, plan, and member configurations are where Noyo shares and receives details that are unique to a carrier. Every other part of Noyo’s payloads are standardized, but the configurations hold the unique fields and classifications that change from connection to connection. As part of preparing to connect to a new carrier, you need to understand the contents of each configuration and be sure your system is able to send the required data for each member.

​

Get the group configuration from Noyo

The group carrier configuration endpoint returns information about how the group is labeled and categorized within the carrier’s system. You can also see this data in the Command Center on a group’s detail page by clicking one of their carrier connections.

VSP groups will be configured with a master_agreement_number string, which is the primary group identifier, along with a list of one or more divisions (4 digit numeric code) to categorize employees enrolling in coverage.

{
    "group_id": "da8d32cc-ce9d-4cf3-9360-733ee0023f1f",
    "carrier_id": "66a21c95-4764-4acb-91a4-08319e27f507",
    "configuration": {
        "master_agreement_number": "1234567",
        "divisons": [
            {
                "division_identifier": "1001",
                "division_name": "AcmeCo division 1"
            }
        ]
    }
}

​

Plan configuration

The details in the plan configuration should be used to map each Noyo plan to the corresponding plan in your own system. Importantly, each plan configuration has details about which populations are connected to an individual plan. Groups with multiple populations may link a plan with one or more of them.

Some VSP plans are only available for employees in certain groups. VSP plans will include a plan_configuration ****block with division_identifiers fields containing lists of string identifiers. The group identifiers will match the groups in the group’s carrier configuration respectively, and describe which groups are eligible to enroll in the plan.

​

Send the member configuration to Noyo

Each member snapshot sent to Noyo can contain a configuration section. Depending on each carrier’s requirements, you may need to use this section to include carrier-specific identifiers like classes, subdivisions, or bill groups. These go in the coverage block’s carrier_config section and ensure that members are enrolled in the correct coverages. Member snapshots missing a carrier_config section or with incorrect config data will result in a 422 error.

Snapshots with VSP coverage may include an optional division_identifier that matches the corresponding values in the group carrier configuration.

If the caller omits any values included for the plan, Noyo will attempt to resolve the correct identifier cases where only one option is available for the employee.

{
    "division_identifier": "1001"
}

​

Carrier-specific requirements

​

Validations

Noyo will validate the following based on the member carrier configuration:

• The division specified is valid for the group
• The provided division identifiers are valid for the plans specified in the relevant coverages
• Requests to add or modify coverage contain plans that are available to the division fields specified