Reject documents by User

This endpoint allows rejecting an individual document or an envelope (a batch of documents) by sending the required information in the request body.

POSThttps://api.zapsign.com.br/api/v1/refuse/by-user/

How to Use:

Send a payload in JSON format with the following fields:

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

• user_token: (string) Token of the user rejecting the document.

• signer_token: (string) Token of the signer related to the document.

• rejected_reason: (string, optional) Reason for rejecting the document.

Learn more about the types of tokens here

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
user_token*	string	User token
signer_token*	string	Signer token
rejected_reason	string	Reason for rejection

Request example

{
    "doc_token":"e082d806-6b31-4e27-ae9a-e16b603a70b3",
    "user_token":"97ab0000-36d4-xxxx-9ded-00005d690xxxx",
    "signer_token": "8be272d8-20a9-xx-899c-db4edbb846cd",
    "rejected_reason": ""
}

Response

200 -

{
    "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."
}

403

{
    "error": "Refusing this document is not allowed."
}

400

{
    "error": "The signer's email and the user's email are different."
}