Attach a document to a pre-bind contingency
const 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';const form = new FormData();form.append('file', 'file');form.append('notes', 'example');form.append('producer_email', 'example');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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=exampleMultipart upload (file, a PDF up to 15 MB; optional notes, max
2000 characters; 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) and only for a
contingency on the request’s selected quote (404 otherwise). PDF is
the only accepted type (415 for anything else); uploads count toward
your brokerage’s daily document-upload limit (429 when reached).
Signature-collected items (signed_form with e-sign) can also be
satisfied by uploading the signed PDF here.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
A PDF
Responses
Section titled “Responses”The refreshed bind request
object
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.
The producing broker the request is attributed to.
Standing assumptions the retail agent still has to confirm. Non-empty means create/submit will answer 409 assumptions_unconfirmed until attested.
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
The asserted value
One pre-bind item the carrier needs, with your response state.
object
The carrier’s wording of the item.
While the request is drafted, the path to POST a PDF for this item (multipart file); null afterwards.
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.
Plain-language actions for the current state, in order.
Example
{ "status": "drafted", "contingencies": [ { "kind": "question", "status": "pending" } ]}Empty file
Broker_submit scope required
Submission
The bind request is no longer drafted
File exceeds the 15 MB limit
Not a PDF
Wrong document for a carrier-signed application
Daily document-upload limit reached