Reject document

This endpoint allows rejecting an individual document or an envelope (a batch of documents).

POSThttps://api.zapsign.com.br/api/v1/refuse/

How to Use: Send a payload in JSON format with the following fields:

  • doc_token: (string) Token of the document to be rejected.

Conditions:

  • The document must have the status “In progress.”

  • When creating the document, the parameter allow_refuse_signature must be set to true.

Notes:

  • When a document is refused, it receives the watermark "Document refused" and cannot be signed in the future.

  • The endpoint response will also be returned in JSON format.

  • This endpoint is asynchronous and may take a few seconds to update the document's final status.

Headers:

Name
Type
Description

Authorization*

string

API token prefixed by the text "Bearer". Example: Bearer c7f35c84-7893-4087-b4fb-d1f06c23.

Request Body

Name
Type
Description

doc_token*

string

Document token

Response

{
    "message": "Document successfully refused. Please note: this endpoint is asynchronous, so wait for the final PDFs to be ready via webhooks or check them in a few minutes."
}

Last updated

Was this helpful?