Attach a document to a pre-bind contingency

POST

/broker/submissions/{submission_id}/bind-requests/{bind_request_id}/contingencies/{contingency_id}/document

curl --request POST \
  --url https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/bind-requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contingencies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file \
  --form notes=example \
  --form producer_email=example

• Production
• Staging sandbox

Multipart upload (file, a PDF; optional notes; producer_email for machine credentials). Each call appends a file to that item - the same upload the portal wizard performs, and marks the response satisfied. Accepted only while the request is drafted (409 otherwise). Signature-collected items (signed_form with e-sign) can also be satisfied by uploading the signed PDF here.

Authorizations

• brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

bind_request_id

required

string format: uuid

contingency_id

required

string format: uuid

Request Body^required

Media typemultipart/form-data

object

file

required

string format: binary

notes

string

producer_email

string

Responses

200

The refreshed bind request

Media typeapplication/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

id

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"
    }
  ]
}

403

Broker_submit scope required

404

Submission

409

The bind request is no longer drafted

413

File exceeds the 25 MB limit

422

Empty file