Download a submission's package as a ZIP

POST

/broker/submissions/{submission_id}/package/download

const url = 'https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/package/download';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"document_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"include_summary":true}'
};

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/package/download \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "document_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "include_summary": true }'

A ZIP of the risk summary PDF (listing the documents it goes with) and the stored originals of the chosen documents; fillable forms stay fillable. Send document_ids to choose exactly which documents (each must be one of the package’s), or omit it for the ticked set. Set include_summary to false to leave the summary out.

Authorizations

brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

Request Body^required

application/json

object

document_ids

Array<string>

<= 100 items

include_summary

boolean

default: true

Responses

200

The package

application/zip

string format: binary

404

Not found (or not your brokerage’s)

413

The chosen documents are too large for one download (over 200 MB)

422

A document id that isn’t part of this package

502

A stored document could not be retrieved; the message names it