HEhedgespecialty
Binding

Request to bind a released quote

Changed on

The broker's bind authority over the API. Drafts a bind request for the chosen quote — the same request the Hedge portal's bind wizard creates — allocating one response slot per pre-bind contingency the carrier listed. Idempotent per carrier lane: re-posting for the same quote returns the existing draft (and records any new attest_assumptions).

Assumptions. Instant quotes are obtained on recorded assumptions (values Hedge defaulted on the carrier application because the file did not state them). They print on the signable application, so the retail agent must confirm them before the order reaches the carrier. This is the only bind check, and it is surfaced here rather than holding a submitted request silently: while any remain unconfirmed the response is 409 assumptions_unconfirmed listing them; the draft is kept. Re-POST with attest_assumptions: true (or the keys the agent confirmed) to record the confirmation and receive the draft. Nothing is sent to a carrier by this call.

Money. Lanes whose bind collects card payment in the portal (direct-bill carriers) cannot be submitted over the API; submit answers 422 with the reason. Requires the broker_submit scope; machine credentials must name producer_email.

post/broker/submissions/{submission_id}/bind-requests

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Path parameters

submission_idstring uuid required

Request body

quote_idstring uuid required

The released firm quote to bind: the quote_id shown on this submission's rail lanes / markets rows. Indications cannot be bound (422).

payment_option'in_full' | 'monthly'

The payment plan requested on the bind order.

producer_emailstring

REQUIRED with a machine credential; the active portal user this bind is attributed to (requested_by). Ignored for per-user tokens.

Response

The bind request draft (or the existing draft for this quote)

bind_request_idstring uuid required
submission_idstring uuid required
status'drafted' | 'submitted' | 'sent' | 'binder_received' | 'bound' | 'bind_failed' | 'cancelled' | 'declined' | 'expired' required

drafted: checklist open (upload documents, confirm assumptions, then submit). submitted/sent: Hedge is placing the bind with the carrier. binder_received: the carrier confirmed the bind; coverage is bound and its policy documents are pending. bound: the policy is issued (it appears under GET /broker/policies and a bound event is emitted). bind_failed: Hedge is reviewing.

status_labelstring required
quote_idstring uuid nullable
payment_optionstring nullable
requested_atstring date-time required
requested_bystring nullable

The producing broker the request is attributed to.

effective_datestring date nullable
policy_idstring uuid nullable
next_stepsstring[] required

Plain-language actions for the current state, in order.

Changes