ICHRA Quote Status

View ICHRA quote metadata and poll for completion

ICHRA Group Quoting is under development. Endpoint schemas and other components stated in this section are subject to change.

The "Show an ICHRA Quote" endpoint (technical API docs will be available on release) can be used to poll for status of an ICHRA quote. This endpoint shows all quote information - both the request parameters and metadata. The same schema is included in successful responses to the "Create and ICHRA Quote" endpoint.

Polling ICHRA Quote Status

The job.status field should be used for polling to assess quote readiness. A complete or complete_with_error status indicates that the quote processing has completed and results are available as documented in the Pull Quote Results section. A failed status indicates that the processing is complete, but the group was not able to be quoted. The failed status is expected to be very rare; failed quotes can be re-tried automatically. Multiple successive failures should be escalated to Ideon's support portal.

The cadence at which any given quote is polled for its status should be dynamic based on the group size and expected processing times, as documented in the ICHRA Group Quoting section FAQ.

ICHRA Quote Metadata

The metadata for an ICHRA quote includes the unique id for the quote, information on the asynchronous processing, and bulk export file availability, if requested as an optional output. These additional fields are shown in the example request below.

GET /ichra_quotes/<ichra_quote_id>

{
    "quote": {
        // ICHRA quote request parameters,
        "id": "abcd1234",
        "created_at": "2026-01-01T00:00:00.000Z",
        "job": {
            "status": "complete",
            "status_updated_at": "2026-01-01T00:01:00.000Z",
            "total_members": 10,
            "total_dependents": 10,
            "error_count": 0
        },
        "bulk_export": {
            "export_id": "24c47bf1-d06e-4711-862a-bdf9ae0acd81",
            "status": "complete",
            "download_url": "https://example.com"
        }

    }
}

ICHRA Quote Job Data

The job object contains processing status information for the ICHRA quote in addition to quote metadata. The following parameters are included.

• Status status - the status of the ICHRA quote job that can be referenced when polling for completion. Valid statuses include the following:

  • pending - initial status indicating that no members quoted yet and processing is not started beyond initial quote creation.

  • in_progress - job processing is underway, some but not all members are quoted.

  • complete - job processing is complete and all members were successfully quoted.

  • complete_with_errors - job processing is complete and one or more members were not able to be quoted.

  • failed - a more significant failure occurred and no members were quoted.

• Status Last Updated At status_updated_at - the timestamp of when the status last transitioned statuses.

• Total Members and Dependents total_members and total_dependents - the sum of members and their dependents in the group when the ICHRA quote was created.

• Member Error Count error_count - the number of members that were not able to be quoted. If the status is returned as complete_with_errors, then this count will be greater than 0.

Bulk Export Job Data

Bulk files are an optional quote output, documented in the Quote a Group for ICHRA and Pull Quote Results sections. The metadata included in the bulk_export object includes an identifier, status, and download URL for the file. When the status is returned as complete, a pre-signed URL to download the file will be available in the download_url field. This process is consistent with the Bulk Exports in the API workflow.