Skip to main content
POST

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Headers

Idempotency-Key
string

Any non-empty string; deterministic keys from your own IDs work best. Repeating the same key with the same body on the same endpoint and mode within 24 hours returns the stored successful response (with Idempotent-Replay: true) instead of re-executing. Error responses are not stored.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

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

Query Parameters

view
enum<string>

Broker keys only. numbers (the default) returns each plan's prices, deductible, out-of-pocket maximum and the most extra the company pays. full adds what each plan is: description, benefits, logos. Other partners always get the whole quote.

Available options:
numbers,
full
fields
string

Comma-separated fields to return, e.g. plans.pmpm_cents. Reach into the plans with plans.<field>. quote_id, group_id and status are always returned. Also accepted as fields in a POST body.

exclude
string

Comma-separated fields to leave out, e.g. plans.logos. Logo URLs do not change, so fetch them once, cache them and exclude them after. Also accepted as exclude in a POST body.

Body

application/json
plan_year_start_date
string<date>

Defaults to the first of the month at least 60 days out.

Example:

"2026-09-01"

send_emails
boolean
default:true

When the quote is priced, your team's listed addresses get two emails: the materials to forward to the employer (each PDF attached) and a For you email with the quote, the client email draft and Presenting Prescience. Send false to turn both off for this group; the choice holds until you send it again.

prior_pepm_cents
integer

Optional legacy input. New integrations should omit it; market-rate savings use the local platinum PPO benchmark.

Example:

80000

view
enum<string>

As the view query parameter.

Available options:
numbers,
full
fields
string[]

As the fields query parameter, as a list.

Example:
exclude
string[]

As the exclude query parameter, as a list.

Example:

Response

The quote.

The quote as a broker gets it: numbers only by default, and what each plan is with view=full.

quote_id
string
required
group_id
string
required
status
enum<string>
required
Available options:
ready,
in_review,
expired
plans
object[]
required
materials
object[]

Quote-specific sales previews for employees and employers. Forwardable links include an interactive view and PDF. Pending group links become available when pricing completes; a changed census requires a new quote. Preview terms are subject to underwriting and enrollment. Links are omitted when signing is unavailable.

expires_at
string<date-time>
plan_year_start_date
string<date>
census
object
ignored_plans
object[]

Plans you sent that were skipped, and why.