/api/v1/documentsList documents in the API key’s workspace.
Developer platform
Build signing workflows with the SignWorkflow API
Create documents, prepare fields, send signing requests, monitor status, download completed PDFs, and receive signed lifecycle events using workspace-scoped credentials.
This page is the human-readable reference. The OpenAPI JSON is the machine-readable contract for API tools, generated clients, and import into Postman or Swagger UI.
Quick start
From API key to completed PDF
- 1
Create a workspace API key with only the scopes your service needs.
- 2
Upload a PDF, then prepare recipient fields before sending.
- 3
Inspect document status and download the completed PDF.
- 4
Receive signed lifecycle events at a configured webhook endpoint.
Authentication
Use a scoped workspace API key
Workspace administrators create API keys in Developer integrations. Use documents:read for reading documents and downloads; add documents:write only to create, prepare, send, or retry documents.
curl --request GET "https://signworkflow.com/api/v1/documents?page=1&limit=25" \
--header "X-API-Key: sw_live_your_secret"You can also send the same key as a Bearer token. Keep it in a server-side secrets manager—never in browser code, mobile apps, logs, or source control.
API reference
Supported document endpoints
/api/v1/documentsUpload a Base64-encoded PDF and create a document draft.
/api/v1/documents/{documentId}Retrieve document status and recipient-safe details.
/api/v1/documents/{documentId}/prepareSet the recipient fields for a draft PDF.
/api/v1/documents/{documentId}/sendSend a prepared document for signing.
/api/v1/documents/{documentId}/send/retryRetry failed signing-request delivery.
/api/v1/documents/{documentId}/downloadDownload a completed document PDF.