Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Group Quote Intents

Create a group quote intent

Creates a group_quote_intent to request a quote for a group and plan combination. The intent coordinates the quote workflow including requirements collection and quote generation.

post/group_quote_intents

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request body

group_idstring required

Unique identifier for the group to get a quote for

plan_idstring required

Unique identifier for the plan to get a quote for

expected_start_datestring date nullable

Expected start date for the insurance coverage

Response

OK

idstring required

Unique identifier for the group quote intent

group_idstring required

Unique identifier for the group

plan_idstring required

Unique identifier for the plan

status'processing' | 'action_required' | 'awaiting_quote' | 'quote_available' | 'rejected' | 'rejected_by_insurer' | 'quote_expired' required
expected_start_datestring date nullable

Expected start date for the insurance coverage

objectstring

Object type identifier

Example response

{
  "id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "cost_sharing": {
    "member_count": {
      "adults": 123,
      "children": 123
    },
    "member_selection": {
      "partner": true,
      "children": true
    },
    "percentage": {
      "percentage": 123
    }
  },
  "expected_start_date": "2024-12-01",
  "action_required": {
    "due_by": "2024-12-01T00:00:00Z"
  }
}