Skip to main content

Download a Document PDF

A form can be configured to produce several named PDF documents from a single signing — for example a Rental Contract and an Acknowledgement of Risk, each printing only the questions assigned to it. This endpoint downloads one of those documents on its own.

Each document a response produces is listed in the documents array of the Get Response payload, with a ready-to-use download_url.

Endpoint​

GET /v1/waivers/{id}/responses/{responseId}/documents/{documentId}/pdf

Authentication​

Requires an API key with the waivers:read scope.

Path Parameters​

ParameterTypeDescription
idintegerWaiver/form ID
responseIdintegerResponse ID
documentIdintegerDocument ID (from the response's documents array)

Query Parameters​

ParameterTypeDescription
languagestringOptional. When a document is configured to generate in more than one language, download a specific one (e.g. fr). Must be one of the document's available languages — see the languages array in Get Response — otherwise the signed language is returned. Omit for the signed language.

Example Request​

curl -X GET "https://app.equipdash.com/api/v1/waivers/1/responses/42/documents/3/pdf" \
-H "Authorization: Bearer YOUR_API_KEY" \
--output acknowledgement-of-risk.pdf

Success Response (200 OK)​

Returns the PDF file directly (not a JSON envelope).

HeaderValue
Content-Typeapplication/pdf
Content-Dispositionattachment; filename="{customer-slug}_{document-slug}_{signed-at}_{response-id}.pdf"

The PDF contains your business branding, the document's title and optional intro text, and only the questions assigned to that document (with their answers inline). Questions hidden from the customer by conditional logic never appear. If the document is configured to require a staff counter-signature and one has been applied, it is printed at the end.

Error Responses​

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks waivers:read scope
404resource_not_foundWaiver, response, or document not found

Notes​

  • The document must belong to the specified waiver/form, otherwise a 404 is returned.
  • The PDF is generated on demand from the stored response — it always reflects the current saved answers.
  • Multi-language: a document can be set to generate in more than one language. The headings, text and question labels are translated; the customer's answers print verbatim in every language. Use ?language= to pick one, or read the languages array in Get Response.
  • To download every document at once as a zip, use the Download Response PDF endpoint on a form that has several documents.