Tell us about your group
carrier_group_id
in the Noyo system), you can send a group connection request.
Group connections cannot be fully completed until the carrier has finished installing all the group’s account structure and plans in their system. We will re-try requests if the carrier is not ready yet, but in some cases there may be additional authorization needed as well. A status for each group connection is available in the API response or in the Command Center (where you can also trigger a retry and amend information).
carrier_id
field, found in many areas of the Noyo API, is a unique ID that Noyo assigns to each carrier in our network, while the carrier_group_id
identifies the group in the carrier system, essentially like a group number, policy number, or master agreement number.
Unique carrier identifiers and guidance on how to find the relevant carrier_group_id
is available in the Command Center on each carrier’s info page.
When your API call to create a group connection request is successful, the response will return a unique ID for the Group Connection, and a unique ID for the Group added to Noyo. We recommend storing both IDs to reference those objects, while Noyo works in the background to ensure we have access to the group.
You can pipe all your group connection requests into your own internal tools or manage them in our Command Center.
completed
. At this point, you can use our API endpoints to access all the data we have about the group.
Group connections will move through several different statuses, as illustrated in the diagram above. Here’s what those statuses mean:
Key | Description |
---|---|
created | This status is the result of the initial submission (POST). We have not yet verified the current state of the carrier’s system. |
processing | We are communicating the group connection to the carrier involved. |
noyo_review | Noyo is actively resolving an issue with the group connection; no action is needed from you. |
waiting_on_carrier | The group connection has been submitted and the carrier is processing it. |
carrier_authorization | There was an authorization problem when pulling group data from a carrier. It may require you to reach out to the carrier to resolve. |
action_required | Action from you is required for successful processing. Notes are listed in the setup_result field on the group connection object. |
unable_to_connect | The carrier was unable to install this group connection. Notes are listed in the setup_result field on the group connection object. |
completed | The group connection has been completed and Noyo now has the ability to manage enrollment and eligibility changes for the specific group that is installed on the carrier’s system |
setup_result
allows us to pass along information that may be helpful in troubleshooting a failed group connection request. Its structure will depend on the group connection’s status: if the request is in noyo_review
, action_required
, waiting_on_carrier
, or unable_to_connect
, the setup result
may contain an error
string that gives further details about the specific issue involved. For other statuses, the setup_result
will be empty.
custom_individual_id
included for each member. The success responses will contain each person’s Noyo ID, which you should include in future snapshots along with your custom ID. All 4xx errors will need to be resolved at this time to ensure that all enrollments are present and the Noyo team can build the file successfully.
complete
in our system and new enrollments and changes can be sent to Noyo on an ongoing basis. We process these snapshots and identify the changes that should be sent on the next file (check the carrier’s page in the Command Center for specifics on file delivery cadence). After the group connection is complete
, you don’t need to communicate changes directly to the carrier anymore.
completed
. At this point, you can use our API endpoints to access the most recent data you’ve sent us about the group.
Group connections will move through several different statuses, as illustrated in the diagram above. The status values are the same for all group connections, but the meanings vary slightly for Send connections:
Key | Description |
---|---|
created | This status is the result of the initial submission (POST). We have not yet verified the current state of the carrier’s system. |
processing | We are communicating the group connection to the carrier involved. |
noyo_review | Noyo is actively resolving an issue with the group connection; no action is needed from you. |
waiting_on_carrier | We are waiting to receive group setup instructions from the carrier, or waiting to receive feedback on test files from the carrier. |
carrier_authorization | We are working to obtain group information from the carrier before testing begins. |
action_required | You need to either map plans and send the group census or resolve data discrepancies shared by the carrier. |
unable_to_connect | The carrier was unable to accept this group connection. |
completed | The production file was approved and you can manage enrollment and eligibility changes through Noyo for this group. |
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. See carrier pages in Command Center for per-carrier formats. |
unable_to_connect
state, you can retry the group connection later through this endpoint. When you retry a group connection, you will have the option to update the unique identifier for the group (carrier_group_id
).
Retrying a group connection keeps the id
that was previously used to identify the group connection, and sends off the same request with any updated information to the carrier. This retry will update the status of the group connection to processing
.