How to Revoke eSignature Document Access

BoldSign allows senders to cancel or revoke a document after it has been sent for signature, but this can only be done before the document is signed. This may be necessary if errors or inaccuracies are discovered in the document, or if it was sent to the wrong recipient. Once the document is canceled, signers will no longer be able to proceed with signing, and both the sender and signer will receive email notifications about the cancellation.

Below is a code snippet demonstrating how to revoke or cancel a document via the API.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/document/revoke?documentId={Your document id}' \
  -H 'X-API-KEY: {Your API Key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '{
  "message": "Reason for revocation or cancellation",
}'

using BoldSign.Api;

var apiClient = new ApiClient("https://api.boldsign.com", "{Your API Key}");
var documentclient = new DocumentClient(apiClient);
await documentclient.RevokeDocumentAsync("{Your document id}", "Reason for revocation or cancellation").ConfigureAwait(false);

import boldsign

configuration = boldsign.Configuration(host = "https://api.boldsign.com", api_key = "YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)
    
    revoke_document = boldsign.RevokeDocument(message = "Testing revoke document API")

    document_api.revoke_document(
        document_id = "YOUR_DOCUMENT_ID",
        revoke_document = revoke_document
    )

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\RevokeDocument;

$config = new Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$document_api = new DocumentApi($config);

$revoke_document = new RevokeDocument();
$revoke_document->setMessage('Testing revoke document API');

$document_api->revokeDocument($document_id = 'YOUR_DOCUMENT_ID', $revoke_document);

ApiClient client = Configuration.getDefaultApiClient();
client.setHost("https://api.boldsign.com"); 
client.setApiKey("YOUR_API_KEY");

DocumentApi documentApi = new DocumentApi(client);

RevokeDocument revokeDocument = new RevokeDocument();
revokeDocument.setMessage("Testing revoke document API");

documentApi.revokeDocument("YOUR_DOCUMENT_ID", revokeDocument);

import { DocumentApi, RevokeDocument } from "boldsign"; 

const documentApi = new DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");

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

documentApi.revokeDocument("YOUR_DOCUMENT_ID", revokeDocument);

In the provided code examples, ensure that you update the documentId with the actual ID of the document you created. Once the code is executed, the document will be revoked, and the recipient will no longer be able to access it.