Skip to main content
GET
Get a quote

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Keys are stored hashed and cannot be recovered; store them in your secrets manager on issue.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

Pattern: ^grp_[0-9a-f]{12}$
quoteId
string
required

Quote ID, e.g. qt_5b9e2c7f10ad.

Pattern: ^qt_[0-9a-f]{12}$

Response

The quote.

id
string
required
Example:

"qt_5b9e2c7f10ad"

groupId
string
required
Example:

"grp_8c2f41d09a3e"

mode
enum<string>
required
Available options:
test,
live
status
enum<string>
required

ready for most groups (synchronous). Groups above the in-review employee threshold (default 200) return in_review and are finalized by Prescience underwriting; listen for the quote.finalized webhook.

Available options:
ready,
in_review,
expired
pricingBasis
string
required

Always indicative: rates are indicative pending underwriting confirmation and bind only at enrollment plus underwriting sign-off.

Allowed value: "indicative"
plan
object
required
planYearStartDate
string<date>
required
Example:

"2026-09-01"

expiresAt
string<date-time>
required

Expiry is configuration-driven; the default window is 30 days after creation. Enrolling against an expired quote returns 410 quote_expired.

census
object
required
monthly
object
required
annual
object
required
employeeContribution
object
required
comparison
object
required
fundingBreakdown
object
required
assumptions
string[]
required
createdAt
string<date-time>
required
pricing
object

Pricing metadata: which configuration layer produced this quote. Additive in v1.1; absent on quotes created before it. All other quote fields are unchanged.