HEhedgespecialty
Binding

Get one bind request

Changed on

Current status, the assumptions still unconfirmed, each pre-bind contingency with your response state and (while drafted) its upload path, and plain next_steps. Poll this, or the submission events feed / webhooks for bound.

get/broker/submissions/{submission_id}/bind-requests/{bind_request_id}

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
bind_request_idstring uuid required

Response

Bind request

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