Get one bind request

GET

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

const url = 'https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/bind-requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/bind-requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

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.

Authorizations

brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

bind_request_id

required

string format: uuid

Responses

200

Bind request

application/json

object

bind_request_id

required

string format: uuid

submission_id

required

string format: uuid

status

required

drafted: checklist open (upload documents, confirm assumptions, then submit). submitted/sent: Hedge is placing the bind with the carrier. binder_received/bound: the placement completed (the policy appears under GET /broker/policies and a bound event is emitted). bind_failed: Hedge is reviewing.

string

Allowed values: drafted submitted sent binder_received bound bind_failed cancelled declined expired

status_label

required

string

quote_id

string format: uuid

nullable

payment_option

string

nullable

requested_at

required

string format: date-time

requested_by

The producing broker the request is attributed to.

string

nullable

effective_date

string format: date

nullable

policy_id

string format: uuid

nullable

unconfirmed_assumptions

required

Standing assumptions the retail agent still has to confirm. Non-empty means create/submit will answer 409 assumptions_unconfirmed until attested.

Array<object>

One assumption Hedge made to obtain the quote (a value it defaulted on the carrier application because the file did not state it) that the retail agent has not yet confirmed. key is what attest_assumptions lists; label is the plain-language statement; value is the exact value asserted to the carrier (absent when the entry records none).

object

key

required

string

label

required

string

value

The asserted value

contingencies

required

Array<object>

One pre-bind item the carrier needs, with your response state.

object

required

string format: uuid

kind

required

string

Allowed values: question signed_form loss_runs file_upload

label

required

The carrier’s wording of the item.

string

status

required

string

Allowed values: pending satisfied waived

required

required

boolean

upload_path

While the request is drafted, the path to POST a PDF for this item (multipart file); null afterwards.

string

nullable

esign_status

Envelope state of a signature request started for this item through the Hedge portal wizard (e.g. sent, completed, queued_for_review); null when none.

string

nullable

next_steps

required

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

Array<string>

Example

{
  "status": "drafted",
  "contingencies": [
    {
      "kind": "question",
      "status": "pending"
    }
  ]
}

404

Not found (or not your brokerage’s)