Cancel Signing Process

Overview

The Cancel Signing Process API allows you to terminate an active signing process. This is useful when a signing process is no longer needed, for example if the document has been superseded or the agreement is no longer relevant.

API Endpoint

DELETE /management/signing

Authentication

This endpoint requires basic authentication. You need to include your API credentials in the request header:

Authorization: Basic base64(companyKey:ApiKey)

Where base64(companyKey:ApiKey) is the Base64 encoding of your companyKey and ApiKey separated by a colon.

Request Parameters

Parameter	Type	Required	Description
ProcessKey	string	Yes	The unique identifier for the signing process to cancel
User	string	No	The email address of the user canceling the process. Used to register in the activity log who performed the cancellation.

Both parameters are sent as query parameters.

Response

The API returns an empty response on successful cancellation.

Response Codes

• 204 No Content: The signing process was successfully canceled
• 400 Bad Request: The request parameters were invalid
• 404 Not Found: The signing process could not be found
• 500 Internal Server Error: Server error

Examples

cURL

curl -X DELETE "https://onboarding.taktikal.is/management/signing?ProcessKey=sp231f52f87d6f&User=your@email.com" \
  -H "Authorization: Basic $(echo -n 'your_companyKey:your_ApiKey' | base64)"

JavaScript

const cancelSigningProcess = async () => {
  // Create basic auth credentials
  const credentials = btoa("your_companyKey:your_ApiKey");

  const processKey = "sp231f52f87d6f";
  const user = "your@email.com";

  const response = await fetch(
    `https://onboarding.taktikal.is/management/signing?ProcessKey=${processKey}&User=${encodeURIComponent(user)}`,
    {
      method: "DELETE",
      headers: {
        Authorization: `Basic ${credentials}`,
      },
    }
  );

  if (response.ok) {
    console.log("Signing process canceled successfully");
  } else {
    console.error("Failed to cancel signing process:", await response.text());
  }
};

cancelSigningProcess();

C#

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

public class SigningService
{
    private readonly HttpClient _httpClient;
    private readonly string _baseUrl;
    private readonly string _companyKey;
    private readonly string _apiKey;

    public SigningService(string baseUrl, string companyKey, string apiKey)
    {
        _baseUrl = baseUrl;
        _companyKey = companyKey;
        _apiKey = apiKey;
        _httpClient = new HttpClient();

        // Set up basic authentication
        var authValue = Convert.ToBase64String(Encoding.UTF8.GetBytes($"{_companyKey}:{_apiKey}"));
        _httpClient.DefaultRequestHeaders.Authorization =
            new AuthenticationHeaderValue("Basic", authValue);
    }

    public async Task CancelSigningProcessAsync(string processKey, string user)
    {
        var response = await _httpClient.DeleteAsync(
            $"{_baseUrl}/management/signing?ProcessKey={processKey}&User={Uri.EscapeDataString(user)}");

        response.EnsureSuccessStatusCode();
    }
}

// Example usage
public async Task CancelSigningProcessExample()
{
    var service = new SigningService(
        "https://onboarding.taktikal.is",
        "your_companyKey",
        "your_ApiKey");

    try
    {
        await service.CancelSigningProcessAsync("sp231f52f87d6f", "your@email.com");
        Console.WriteLine("Signing process canceled successfully");
    }
    catch (Exception ex)
    {
        Console.Error.WriteLine($"Failed to cancel signing process: {ex.Message}");
    }
}

What Happens When a Process Is Canceled

• Document deletion: The document is immediately deleted and can no longer be viewed by anyone.
• Signee notification: All signees in the process receive an email notifying them that the signing has been canceled.
• Already signed documents: If any signee has already signed the document, a copy is emailed to the process owner before the document is deleted.

Notes

• If the signing process is part of a sequence, the entire sequence will be canceled.
• Once a signing process is canceled, it cannot be reactivated. You will need to create a new signing process if needed.
• The User parameter is optional but recommended, as it records who performed the cancellation in the activity log.