Revoke document

post/v1/document/revoke

The document signing process can be called off or revoked by the sender of the document. Once you revoke a document, signers can no longer view or sign it.

Revoke action can only be performed on documents that have not completed the signing process.

Code snippet

curl -X POST "https://api.boldsign.com/v1/document/revoke?documentId={documentId}" 
     -H 'X-API-KEY: {your API key}' 
     -H "Content-Type: application/json" 
     -d "{\"message\": \"This is document revoke message\"}"
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}");
var documentclient = new DocumentClient(apiClient);
await documentclient.RevokeDocumentAsync("{documentId}", "This is document revoke message").ConfigureAwait(false);
import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    document_api = boldsign.DocumentApi(api_client)
    revoke_document = boldsign.RevokeDocument(
        message="This is document revoke message"
    )
    
    document_api.revoke_document(document_id="YOUR_DOCUMENT_ID", revoke_document=revoke_document)
<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$document_api = new BoldSign\Api\DocumentApi($config);
$revoke_document = new \BoldSign\Model\RevokeDocument();
$revoke_document->setMessage("This is document revoke message");

$document_api->revokeDocument($document_id = 'YOUR_DOCUMENT_ID', $revoke_document);
ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
        
DocumentApi documentApi = new DocumentApi(client);
RevokeDocument revokeDocument = new RevokeDocument();
revokeDocument.setMessage("This is document revoke message");

documentApi.revokeDocument("YOUR_DOCUMENT_ID", revokeDocument);
import { DocumentApi,RevokeDocument } from "@boldsign/node-sdk";

const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");

const revokeDocumentRequest = new RevokeDocument();
revokeDocumentRequest.message = "This is document revoke message";

documentApi.revokeDocument("YOUR_DOCUMENT_ID", revokeDocumentRequest);

Query parameters

documentIdstringRequiredID of the requested document to revoke.

Request body

messagestringRequiredThe exact reason for performing a revoke action.
onBehalfOfstringIf the document is created on behalf of the sender, the sender's identity email address must be specified.

Example response

204 No Content