ZapSign

Overview

The node integrates with the ZapSign API to manage electronic document workflows, including creation, sending, signing, cancellation, and more. Specifically, for the Document - Cancel operation, it allows users to cancel a document by providing its unique token and a reason for cancellation. This is useful in scenarios where a document needs to be invalidated or withdrawn from the signing process due to errors, changes, or other business reasons.

Practical examples:

• Canceling a contract document that was sent by mistake.
• Revoking a document signature request when terms have changed.
• Storing a cancellation reason in the document history for audit purposes.

Properties

Output

The output is a JSON object representing the response from the ZapSign API after attempting to cancel the document. It typically includes confirmation of the cancellation status and any relevant metadata returned by the API.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "status": "canceled",
  "doc_token": "string",
  "message": "Cancellation successful",
  ...
}

Dependencies

• Requires an API key credential for authenticating with the ZapSign API.
• Uses environment variables to determine the API base URL (ZAPSIGN_API_BASE_URL_SANDBOX or ZAPSIGN_API_BASE_URL).
• Relies on HTTP POST requests to the ZapSign API endpoint /api/v1/refuse/ for cancellation.

Troubleshooting

Common Issues

• Invalid or missing Document Token: The cancellation will fail if the provided document token is incorrect or not active.
• Missing Rejected Reason: The node requires a reason for cancellation; omitting this will cause an error.
• API Errors: Network issues or API downtime can cause failures.
• Permission or Plan Restrictions: Some accounts may not have permission to cancel documents or may require specific plan features.

Error Messages and Resolutions

• 400 Bad Request:

  • Indicates the document cannot be canceled because it does not meet required conditions.
  • Possible causes:
    • Document status is not "In progress".
    • Document was not created with refusal/cancellation allowed.
    • Document is already completed, expired, or invalid.
  • Resolution:
    • Verify the document status.
    • Confirm the document was created with cancellation enabled.
    • Check the validity of the document token.

• Other HTTP Errors:

  • Inspect the error message and ensure API credentials and parameters are correct.
  • Check network connectivity and API availability.

Links and References

• ZapSign API Documentation (general reference for API endpoints and usage)
• ZapSign support for account and feature inquiries.

This summary focuses exclusively on the Document - Cancel operation as requested, based on static analysis of the provided source code and property definitions.