Skip to main content

PDF Document Retrieval

Retrieve PDF documents from the signing process, including signed documents with signatures.

Endpoint​

GET /api/pdf/{ProcessKey}/{SigneeKey}.pdf
HEAD /api/pdf/{ProcessKey}/{SigneeKey}.pdf

Description​

This endpoint allows you to retrieve PDF documents from a signing process. If the document has been signed, it will return the PDF with the signatures included. This endpoint serves as an alternative to webhooks for retrieving completed signed documents.

Authentication​

This endpoint requires authentication if the signing process was created with requiresAuth=true. It is recommended to always use the auth header for security purposes.

For detailed authentication instructions, see the Authentication page.

Headers​

HeaderTypeRequiredDescription
AuthorizationstringConditionalRequired if signing process has requiresAuth=true. Use the same auth header as when creating the signing process. Recommended to always include for security

Parameters​

Path Parameters​

ParameterTypeRequiredDescription
ProcessKeystringYesThe signing process key that identifies the signing session
SigneeKeystringYesThe signee key that represents the document signer

Response​

Success Response​

Code: 200 OK

Content-Type: application/pdf

Description: Returns the PDF document. If signed, includes all signatures.

Example Request​

GET /api/pdf/spd132dc9a9da047d1be5b6011e90a611e/sixyz78sie6576f7cbb6741378759596d0d5387749.pdf

Use Cases​

  • Retrieve signed PDF documents with signatures
  • Alternative to webhook notifications for getting completed documents
  • Download documents at any stage of the signing process
  • Implement document retrieval in applications that cannot use webhooks
  • Provide download functionality for signed documents

Document States​

  • Unsigned: Returns the original PDF document without signatures
  • Signed: Returns the PDF document with all applied signatures
  • Partially Signed: In multi-signer scenarios, returns the document with signatures from completed signers

Notes​

  • This endpoint serves as an alternative to webhooks for document retrieval
  • The returned PDF will include signatures if the signing process has been completed
  • Both ProcessKey and SigneeKey are required to access the specific document
  • The endpoint supports both GET and HEAD methods for flexibility in implementation