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 - Add operation allows you to add a new signer to an existing document, specifying their contact details and authentication requirements.

Common scenarios where this node is useful include:

  • Automating the process of adding signers to contracts or agreements stored in ZapSign.
  • Setting up multi-factor authentication for signers via email, SMS, or WhatsApp.
  • Enforcing additional security measures such as ID document upload or facial recognition before signing.

For example, after uploading a contract document, you can use this node to add a signer by providing their email and name, choose how they authenticate (e.g., SMS), and require facial recognition to ensure identity verification.

Properties

Name Meaning
Document ID The unique identifier of the document to which the signer will be added.
Signer Email Email address of the signer; used for identification and communication.
Signer Name Full name of the signer (optional but recommended for clarity).
Authentication Method Method used to authenticate the signer. Options: Email, SMS, WhatsApp.
Phone Number Phone number required if SMS or WhatsApp is selected as the authentication method.
Require Document Authentication Boolean flag indicating if the signer must upload an ID document for authentication.
Require Facial Recognition Boolean flag indicating if the signer must pass facial recognition verification.

Output

The output JSON contains the response from the ZapSign API after adding the signer. This typically includes details about the newly added signer such as their ID, email, name, authentication settings, and status.

Example output structure (simplified):

{
  "id": "signer-id",
  "email": "signer@example.com",
  "name": "Signer Name",
  "auth_method": "email",
  "require_doc_auth": false,
  "require_facial_recognition": false,
  "status": "pending"
}

No binary data is produced by this operation.

Dependencies

  • Requires an active ZapSign API key credential configured in n8n for authentication.
  • Internet access to communicate with the ZapSign API endpoints.
  • Proper permissions on the ZapSign account to add signers to documents.

Troubleshooting

  • Missing or invalid Document ID: Ensure the Document ID provided exists and is correct; otherwise, the API will return an error.
  • Invalid or missing Signer Email: The email must be valid and unique per document; duplicates or malformed emails cause failures.
  • Phone Number required for SMS/WhatsApp: If SMS or WhatsApp authentication is selected, a valid phone number must be provided.
  • API authentication errors: Verify that the API key credential is correctly set up and has not expired.
  • Permission errors: The authenticated user must have rights to modify the specified document.
  • Network issues: Check internet connectivity and firewall settings if requests fail to reach the API.

If the node throws an error, enabling "Continue On Fail" can help process multiple items without stopping the workflow.

Links and References

Discussion