ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions33

Overview

This node integrates with the ZapSign API to create and manage digital documents for electronic signatures. Specifically, the Document - Create operation allows users to create a new document in ZapSign by uploading or providing the document content in various formats (file upload, base64 string, public URL, or raw Markdown text). The created document can then be sent to one or more signers for electronic signing.

Common scenarios where this node is beneficial include automating contract generation and signature collection workflows, such as:

  • Creating NDAs, agreements, or contracts from uploaded files or URLs.
  • Generating documents dynamically from Markdown content.
  • Managing multiple signers with different authentication modes.
  • Attaching metadata and branding information to documents.
  • Setting signature deadlines and reminders.

Practical example: A company wants to automate sending employment contracts to new hires. Using this node, they can upload the contract PDF, specify the signers with their authentication preferences, and automatically send out signature invitations.

Properties

Name Meaning
Document Name The name/title of the document to be created.
File Input Type How the document content is provided. Options:
• File Upload (binary data)
• Base64 (base64 encoded string)
• Public Link (URL to file)
• Markdown Text (raw markdown content to generate the document)
File (If File Upload) Name of the binary property containing the file data. Default is "data".
Base64 Content (If Base64) The file content encoded as a base64 string.
File Name (If Base64) The filename including extension (e.g., document.pdf).
File MIME Type (If Base64) MIME type of the file (e.g., application/pdf, image/jpeg).
File URL (If Public Link) Publicly accessible URL to the file.
Markdown Text (If Markdown Text) Raw Markdown content used to generate the document.
Signers List of signers for the document. Each signer includes:
• Name (required)
• Email (optional)
• Authentication Mode (e.g., on-screen signature, email token, SMS token, WhatsApp token, digital certificate, none)
• Phone number and country code
• CPF (Brazilian tax ID) and validation options
• Custom message for invitation
• Signature and initials placement coordinates
• Flags for requiring photos/selfie during signing
• Options to send automatic emails or WhatsApp messages
• Redirect link after signing
• Other signer-specific settings
Additional Fields Optional extra settings for the document, including:
• Language of the interface (Portuguese, English, Spanish)
• Disable signer emails
• Brand logo URL, primary color, and brand name for emails
• Allow signer to refuse signature
• Metadata as JSON key-value pairs attached to the document
• External ID for your system
• Folder path in ZapSign (auto-created if missing)
• Creator email
• Signature deadline date
• Enable signature order among signers
• Reminder frequency in days
• Disable signers from downloading original file

Output

The node outputs an array of JSON objects representing the response from the ZapSign API for each processed item/document creation request.

Typical output fields include:

  • Document identifiers and tokens assigned by ZapSign.
  • Status and metadata of the created document.
  • Information about signers and their invitation status.
  • Any error messages or warnings if the creation failed.

The output does not include binary data for the document itself but provides references and tokens to access or manage the document via subsequent operations.

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 for sandbox or ZAPSIGN_API_BASE_URL for production).
  • Relies on HTTP requests to ZapSign endpoints.
  • Supports fetching files from public URLs when using URL input type.
  • Requires n8n's binary data handling capabilities for file uploads.

Troubleshooting

Common Issues

  • Missing or invalid signer information: At least one signer must be provided with a valid name; email may be required depending on authentication mode.
  • Invalid file input: File content must be correctly provided according to the selected input type. For URL inputs, the file must be publicly accessible.
  • Invalid JSON in metadata: Metadata field must contain valid JSON if provided.
  • Unsupported file types or corrupted files: Ensure the file format is supported (PDF, DOCX, images, etc.) and not corrupted.
  • Markdown input unsupported for OneClick operation: Use only file, base64, or URL for OneClick document creation.
  • API errors (400 Bad Request): Usually caused by missing required fields, invalid signer configuration, or file issues.
  • Download failures from URL: Network issues or inaccessible URLs will cause errors.

Error Messages and Resolutions

  • "At least one signer is required": Add one or more signers with valid names.
  • "Failed to download file from URL": Verify the URL is correct and publicly accessible.
  • "Invalid JSON in Metadata field": Correct the JSON syntax in the metadata input.
  • 400 Bad Request on document creation: Check all required fields, validate signer emails, and ensure file content is valid.
  • "Markdown input is not supported for OneClick": Switch to a supported file input type for OneClick operation.
  • Authentication or permission errors: Ensure the API key has proper permissions and the account supports the requested features.

Links and References

This summary covers the logic and usage of the ZapSign node's Document Create operation based on static analysis of the source code and provided property definitions.

Discussion