ZapSign icon

ZapSign

Interact with ZapSign API for digital signatures

Actions15

Overview

This node integrates with the ZapSign API to manage digital signature workflows, specifically focusing on managing signers for documents. The "Signer Update" operation allows users to update details of an existing signer associated with a document. This includes modifying the signer's name, authentication method (email, SMS, or WhatsApp), phone number (if applicable), and security requirements such as document authentication via ID upload and facial recognition.

Common scenarios where this node is beneficial include:

  • Correcting or updating signer information after initial setup.
  • Changing the authentication method for enhanced security or convenience.
  • Enabling or disabling additional verification steps like facial recognition or document authentication.

For example, if a signer initially set up with email authentication needs to switch to SMS authentication, this node can update their details accordingly without removing and re-adding them.

Properties

Name Meaning
Document ID The unique identifier of the document to which the signer belongs.
Signer Email The email address of the signer to update.
Signer Name The full name of the signer.
Authentication Method The method used to authenticate the signer. Options: Email, SMS, WhatsApp.
Phone Number The phone number used for SMS or WhatsApp authentication (required if those methods are chosen).
Require Document Authentication Whether the signer must upload an ID or other document for authentication (true/false).
Require Facial Recognition Whether the signer must pass facial recognition verification (true/false).

Output

The output JSON object contains the updated signer information as returned by the ZapSign API. It typically includes fields confirming the signer's updated attributes such as name, email, authentication method, phone number (if applicable), and verification requirements.

No binary data is output by this operation.

Example output structure (simplified):

{
  "email": "signer@example.com",
  "name": "Updated Signer Name",
  "auth_method": "sms",
  "phone_number": "+1234567890",
  "require_doc_auth": true,
  "require_facial_recognition": false,
  "status": "updated"
}

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 update signer information.

Troubleshooting

  • Error: Signer not found
    Occurs if the specified signer email does not exist for the given document. Verify the document ID and signer email are correct.

  • Error: Invalid phone number
    If SMS or WhatsApp authentication is selected but the phone number is missing or incorrectly formatted, the API will reject the request. Ensure the phone number is provided and valid.

  • Authentication errors
    If the API key is invalid or missing, requests will fail. Confirm that the API credentials are correctly set up in n8n.

  • Permission denied
    The API user may lack rights to update signers. Check ZapSign account permissions.

  • Network issues
    Connectivity problems can cause timeouts or failures. Verify network access to ZapSign API endpoints.

Links and References

Discussion