Documents

Download Document Package

Download everything stored for one document as a zip: document.json with its metadata and parsed contents, document.xml with the document as it went...

GET
/api/v1/documents/{documentId}/download-package

Download everything stored for one document as a zip: document.json with its metadata and parsed contents, document.xml with the document as it went over the network, the original payload it was sent as when there was one, and one file per binary attachment. Use generatePdf to add a rendered auto-generated.pdf, either always or only when the document carries no PDF attachment of its own. The response is application/zip, not JSON.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

documentId*string

The ID of the document to download

Query Parameters

generatePdf?string

When to include the autogenerated PDF in the package

Default"never"
Example"never"
Value in"never" | "always" | "when_no_pdf_attachment"

Response Body

application/zip

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/documents/string/download-package"
"string"