ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signature Validation
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Documents

Reject Documents

POSThttps://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.

Notes:

  • If a document has already been signed by all signers, rejection will not be allowed.

  • When a document is rejected, it receives the watermark "Rejected document" and becomes unable to be signed in the future.

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

  • The document must have the status 'In progress'.

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

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."
}
PreviousOptional: Place signaturesNextSignature Validation

Last updated 2 months ago

Was this helpful?