The Snapshot Workflow
What's happening behind the scenes when you send a snapshot
This section walks you through the complete member change workflow: creating the snapshot, checking its status, confirming changes (if available), and checking employee data.
Sending changes to any carrier
Step 1: Create and send a member snapshot
Submit a snapshot for an employee and their family using POST /api/v1/groups/:group_id/member_snapshots
.
Populate the Employee section with your custom_individual_id
and the employee’s classifications. Set the Employment information and Employment Dates. Send as much demographic information as possible in the Person and Dependent sections.
Populate the Coverages list by adding a block for each plan or coverage the member and their dependent(s) should be enrolled in:
- Set the
line_of_coverage
andplan_id
to the linked Noyo plan - Set the
carrier_config
block to the member’s chosen account structure option(s) (this section may be blank, or be populated according to individual carrier requirements) - Set the
individual_type
andcustom_individual_id
to match your employee record - Set the
effective_start_date
andeffective_end_date
of the coverage. (If a user hasn't requested to terminate coverage, use datemax of 9999-12-31 for the end date.)
Populate the Events section with the event_id
, reason, and date for the relevant event.
With this data, a member snapshot should be ready to send. (Check out our recipes for specific examples of how to formulate a member snapshot for different scenarios.) If successful, you should get a response with a new unique ID for the snapshot, the original contents of the snapshot, and an initial status of submitted
. Your system should record the new snapshot ID to check on the status (see below).
A more specific breakdown of the snapshot format can be found in the API Reference.
Step 2: Noyo validates snapshot content
Noyo validates the request for content and uses encoded carrier logic to ensure it has a chance to be processed by the carrier. For full detail on possible responses, see Snapshot Responses.
Step 3: Changes identified and queued
Noyo will process the snapshot contents, break the snapshot into transactions, generate the correct payload to each target carrier, and determine what queuing might need to happen to conform to the carrier’s requirements.
Step 4: Carrier processes changes
The carrier makes the submitted changes in their system. Most changes for Sync carriers are completed in seconds. The next steps depend on whether you are sending changes for a Sync or Send carrier.
Getting statuses and confirmations (Sync carriers only)
Step 5: Noyo confirms that the change was made
We’ll check that the transmission was successful by immediately checking the carrier’s system to see that their data has been updated to match the request and they are done processing the data. This is the first step of our round-trip confirmation process to ensure that member data is accurate across systems.
Important note: A carrier may finish processing a transaction but not actually update the data in their system correctly. In this case, we will detect the mismatch and raise it as a discrepancy in the Command Center. The transaction (and the member snapshot it belongs to) will have a status of completed
in our system.
Step 6: Check the status of submitted snapshots
Any time after a snapshot has been accepted, you can poll Noyo for its status. See Snapshot Statuses for full details. In short, the statuses returned for Sync carriers can mean:
- One or more transactions in the snapshot have not been completed by the carrier yet (Processing)
- All transactions in the snapshot have been completed by the carrier (Completed)
- The request was canceled and no change was sent to the carrier (Canceled)
- We received a newer snapshot for this family (Replaced)
As soon as the carrier has made the requested changes and no discrepancies are detected, Noyo updates our system to reflect the new data. This will happen at the same time the snapshot status reaches complete
. If any transactions had an effective date in the future, our second round-trip confirmation check validates the data with the carrier again on that date.
Ongoing: GET updated member data on demand and manage discrepancies
You can use our member data endpoints to pull back the latest info into your own system. If desired, you can use this data for reconciliation, or to support your own internal tooling.
We offer out-of-the-box discrepancy management in the Command Center, where you can understand and manage discrepancies, including seeing a side-by-side field comparison between what you submitted and what the carrier has.
Getting statuses (for Send carriers only)
Step 5: Check the status of submitted snapshots
Any time after a snapshot has been accepted, you can poll Noyo for its status. See Snapshot Statuses for full details. In short, the statuses returned for Send carriers can mean:
- All transactions in the snapshot have been sent to the carrier (Completed)
- We were not able to send a file to the carrier and are investigating the issue (Canceled)
- We received a newer snapshot for this family (Replaced)
Ongoing: GET the member data you submitted and resolve discrepancies
You can use our member data endpoints to pull back the latest employee data that we have on file for someone - the source for this data will be the latest member snapshot you submitted.
Our team will pass along the carrier’s discrepancy reports as we receive them. You can resolve discrepancies by updating/correcting data in your system and sending us new member snapshots. If you choose to resolve a discrepancy directly with the carrier, it’s important that you also update Noyo with a new member snapshot to keep data aligned across systems.
Snapshots with Sync and Send changes
If your member snapshot contains changes going to both Sync and Send carriers, it's likely that the Sync transactions will complete quickly while the Send changes have not yet been sent on the file. The status of the snapshot will remain in
processing
until the file is sent, when it moves tocompleted
.
Updated 5 months ago