Documents
Render Document Preview
Render a stored document as a human-readable page.
GET
Render a stored document as a human-readable page. Ask for html to embed the preview in your own interface, or pdf to hand the recipient something to file or print. The rendering is generated from the document's contents, so it is a readable presentation of the data rather than the sender's own layout; a document the sender attached a PDF to carries that PDF as an attachment instead. Document types that have no rendering, and documents whose contents could not be parsed, fail with a 500.
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 render
type*string
The type of the document to render
Value in
"html" | "pdf"Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/documents/string/render/html""string"