ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions15

Overview

This node integrates with the ZapSign API to manage digital signatures on documents. Specifically, the "Signer" resource with the "Remove" operation allows users to remove a signer from a specified document by providing the document ID and the signer's email.

This functionality is useful in scenarios where a signer needs to be revoked or removed from the signing process, for example, if the signer was added by mistake or no longer should have access to sign the document.

Practical example:

  • You have sent a document for signature but realize one of the signers should not participate. Using this node operation, you can remove that signer by specifying the document and the signer's email, preventing them from signing.

Properties

Name Meaning
Document ID The unique identifier of the document from which the signer will be removed.
Signer Email The email address of the signer to be removed from the document's list of signers.

Output

The output JSON contains the response from the ZapSign API after attempting to remove the signer. This typically includes confirmation of the removal or details about the current state of the document's signers.

No binary data is output for this operation.

Example output structure (simplified):

{
  "success": true,
  "message": "Signer removed successfully"
}

(Note: Actual response fields depend on the ZapSign API.)

Dependencies

  • Requires an active connection to the ZapSign API.
  • Requires an API authentication token configured in n8n credentials for the ZapSign service.
  • The node uses HTTP DELETE requests to the ZapSign API endpoint /v1/documents/{documentId}/signers/{signerEmail}.

Troubleshooting

  • Common issues:

    • Invalid or missing Document ID or Signer Email parameters will cause the request to fail.
    • Attempting to remove a signer who does not exist on the document may result in an error or no-op response.
    • Network or authentication errors if the API key credential is invalid or expired.

  • Error messages:

    • "Signer not found": The specified signer email does not exist for the given document. Verify the email and document ID.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set up and has necessary permissions.
    • "Document not found": The provided document ID does not exist or is incorrect.

Resolving these usually involves verifying input parameters and ensuring valid API credentials.

Links and References

Discussion