API Reference

Download document

This endpoint allows for the download of a specific document associated with a UUID. This UUID represents a document which could be of type FCCORE_attachment, FCCORE_emailSent, FCCORE_letterSent or DASHBOARD_email.
It retrieves the required document for the user. The user can choose to download the file directly or receive a signed URL which can be used to download the document. There is also an option to render an email document into HTML instead of returning the raw file.

Log in to see full request history
Path Params
string
required

This is a required string parameter provided in the path. It represents the unique identifier of the document that needs to be downloaded.

Query Params
string

This is an optional query parameter that can take either of two values: redirect or url. The default value is redirect. If redirect is chosen, the API will return an HTTP redirect to download the file from S3. If url is chosen, the API will return a signed URL that can be used to download the document.

string

This is an optional query parameter that, when set to email, will render an email document into HTML rather than returning the raw email file. This parameter is useful when the UUID refers to a DASHBOARD_email.

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json