Void a document

Voids an in-progress document. Works for both single signature PDFs (documentType=PDF) and PDF templates (documentType=PDF_TEMPLATE). Idempotent: already-voided documents return 200 with Document is already voided.

For a single signature PDF, send the public documentId UUID (documentType defaults to PDF). For a PDF template, send the template UUID as documentId, set documentType to PDF_TEMPLATE, and pass the respondent Mongo ObjectId (createdDocumentId from /pdf-template-lambda) as responseId.

Documents in SIGNED, PAID, DECLINED, EXPIRED, or DELETED cannot be voided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 128
^[A-Za-z0-9_-]{1,128}$

Public documentId of the document to void. For a single signature PDF this is the PDF UUID. For a PDF template this is the template UUID.

string
enum
length between 3 and 12
^(PDF|PDF_TEMPLATE)$

PDF (single signature PDF) or PDF_TEMPLATE (PDF template). Defaults to PDF when responseId is omitted, and to PDF_TEMPLATE when responseId is present.

Allowed:
string
length between 24 and 24
^[a-fA-F0-9]{24}$

Required for PDF_TEMPLATE. Mongo ObjectId returned as createdDocumentId from POST /pdf-template-lambda and templateRespondents array in the response of GET /get-documents. Not supported for a single signature PDF (documentType=PDF).

Responses

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