Create a Group

Create a resource for a single group and broker information

circle-exclamation

A group can be created through the "Create a Group" endpoint (API docsarrow-up-right). For ICHRA Group Quoting, v8 of this endpoint must be used, as specified in the Accept-Version header. The technical API documentation for v8 will be released alongside the documentation for the ICHRA Group Quoting endpoints. This page refers to the v8 schema and required fields for ICHRA Group Quoting.

The same group resource can be quoted for multiple product lines and markets, including Small Group Medical, Level Funded, and Ancillary and Supplemental Health.

Configuring Requests

For ICHRA Group Quoting, the group resource is used to associate members and trigger the quote. Additional group data is required when quoting members for ICHRA. Notes on important field requirements and their impact on quoting are included below.

  • Company Name group.company_name - the name of the business or company being quoted. When template or dummy companies are used for testing, "TEST" should be appended to the company_name.

  • SIC Code group.sic_code - the Standard Industrial Classification (SIC) code for the group. The SIC code is not used for ICHRA quotes.

  • Agency and Broker Information group.{agency_name,agency_npn,broker_name,broker_npn,broker_email} - it is recommended to include all agency and broker data fields, if available. At least one of agency_npn or broker_npn is required.

  • Company Tax ID group.company_tax_id - the 9-digit tax identification number for the company being quoted, typically an Employer Identification Number (EIN). Required for ICHRA quotes.

  • Group Locations locations[] - the office locations of the company or business being quoted. A single location must be designated as the primary location of the group. For ICHRA quotes, the group locations do not affect availability of plans or premiums; these are determined by each member's location on the census. However, group locations and their assignment to each member do impact optional ICHRA affordability calculations, if the rating_area_location passed is work.

An example request using v8 and the required fields for ICHRA Group Quoting:

POST /groups
{
    "group": {
        "agency_name": "Agency Name",
        "agency_npn": "123456789",
        "broker_email": "broker@email.com",
        "broker_name": "Broker Name",
        "broker_npn": "123456789",
        "company_name": "Internal Test Group",
        "company_tax_id": "123456789",
        "external_id": "abc123",
        "sic_code": "5411"
    },
    "locations": [
        {
            "zip_code": "10010",
            "fips_code": "36061",
            "name": "Headquarters",
            "number_of_employees": 10,
            "primary": true
        }
    ]
}

Additional Information

Group and Location IDs

Successful requests to the "Create a Group" endpoint will return an id for the group and each location. These are internal identifiers that are referenced in subsequent endpoints for quoting a group. The group.id is referenced in endpoint paths to add a census and quote the group. The locations[].id are referenced to associate members to specific locations when adding a census.

The group.id should be easily accessible for triage workflows; it is required for support requests related to group quoting, along with the quote ID (found in the Quote a Group for ICHRA section).

Re-Creating Groups

If the data associated with a group does not change, re-creating the group for each subsequent quote is not required. In other words, you can re-use a group - through its group.id - to create multiple quotes. Creating a new group is only required if the data associated with the group referenced on this page needs to be updated.

Last updated

Was this helpful?