Skip to main content

Download Response PDF

Download a single completed response as a branded PDF, with every question shown inline next to the customer's answer (including the captured signature). This is the same document a customer receives by email when they sign a waiver, and the same one available from the supplier portal.

Endpoint​

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

Authentication​

Requires an API key with the waivers:read scope.

Path Parameters​

ParameterTypeDescription
idintegerWaiver/form ID
responseIdintegerResponse ID

Example Request​

curl -X GET "https://app.equipdash.com/api/v1/waivers/1/responses/42/pdf" \
-H "Authorization: Bearer YOUR_API_KEY" \
--output signed-waiver.pdf

Success Response (200 OK)​

Returns the file directly (not a JSON envelope). The format depends on whether the form defines multiple PDF documents:

Form configurationReturned fileContent-Type
No documents (default)A single signed-waiver PDFapplication/pdf
One documentThat document's PDFapplication/pdf
Several documentsA zip with one PDF per documentapplication/zip
HeaderValue
Content-Dispositionattachment; filename="{customer-slug}_{signed-at}_{response-id}.pdf" (or .zip)

The single-PDF document includes your business branding, the form name, each question with its answer inline, the signature image, and a footer with the response ID and signing timestamp.

To always download a specific named document on its own — regardless of how many the form has — use the Download a Document PDF endpoint instead.

Error Responses​

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

Notes​

  • The response 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.
  • This endpoint produces the exact same document as the supplier-portal download and the customer's emailed copy.