Document AI — E-Signatures

Cancel signature request (eSignatures API)

WHEN TO USE: cancel a signature request that was created with po_esignatures_create_signature_request. For a signing LINK created with po_signature_links_send_signing_request use po_signature_links_cancel_signing_request. If you do not...

post/signatures/cancel

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/signatures/cancel
  • Auth: HTTP bearer

Request body

signature_idstring required

Signature request ID: the uuid (also request.signature_id) returned by POST /signatures/create. Aliases: request_uuid, uuid, request_id.

request_uuidstring

Alias for signature_id (send instead of signature_id, not in addition with a different value).

uuidstring

Alias for signature_id (send instead of signature_id, not in addition with a different value).

request_idinteger

Numeric request.id from /signatures/create (used only when no UUID field is sent).

reasonstring

Optional cancellation reason.

Response

Success

status'success' | 'error' required

HTTP-Level Status

job_idstring required
messagestring

Menschenlesbare Statusmeldung

pipelinestring
operationstring

Ausgefuehrte Operation

processing_timestring

Gesamte Verarbeitungszeit inkl. Queue (Format: 123.45ms)

Changes

No recorded changes to this operation across all 1 revision of this API.