Create a Group

Create a resource for a single group

A group can be created through the "Create a Group" endpoint (API docsarrow-up-right). In addition to including important rating datapoints like the primary location and SIC code, a successfully created group returns identifiers for both the group and it's locations that must be referenced to add a census and quote the group.

Configuring Requests

To quote a group, data on their locations and industry drive the evaluation of premiums. Notes on important fields 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.

  • 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. The primary location's zip_code and fips_code are used to determine rating area for quoted premiums. In most scenarios, non-primary locations do not affect quoting. A notable exception is eligibility rules for plan availability based on employees living or working within the plan's service area. Given these, it is recommended to always send all locations for the group.

  • Number of Employees per Location locations[].number_of_employees - the number of full-time employees who are eligible for coverage and working at the location.

  • Chamber Association chamber_association - deprecated field, can be defaulted to true.

A sample request with fields required for small group medical quoting, for reference:

POST /groups
{
    "group": {
        "chamber_association": true,
        "company_name": "Foo Bar, Inc.",
        "external_id": "abc123",
        "sic_code": "0700"
    },
    "locations": [
        {
            "zip_code": "10010",
            "fips_code": "36061",
            "name": "Headquarters",
            "number_of_employees": 14,
            "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 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 it's 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?