Reject Documents

POST://api.zapsign.com.br/api/refuse/

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

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

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

  • watermark_message: (string) Custom watermark message. If not provided, the default watermark will be applied: "Document rejected".

Send the doc_token of the main document in JSON format. Optionally, you can include the watermark_message field to customize the watermark message.

Notes:

  • If no custom watermark message is provided, the system will automatically apply the default watermark: "Document rejected".

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

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

watermark_message

string

Custom watermark message

Response

200 Document Rejected Successfully
{
    "message": "Document successfully rejected. Reminder: this endpoint is asynchronous, so please wait for the final PDFs to be ready via webhooks or check back in a few minutes."
}

Last updated

Was this helpful?