Actions33
- Template Actions
- Document Actions
- Signer Actions
- Background Check Actions
- Partnership Actions
- Timestamp Actions
- Webhook Actions
Overview
This node integrates with the ZapSign API to manage electronic document signing workflows. Specifically, the Signer - Add operation allows you to add a new signer to an existing document in the ZapSign system. This is useful when you want to programmatically invite someone to sign a document by specifying their contact details and authentication preferences.
Common scenarios include:
- Adding a new signer to a contract or agreement that requires multiple signatures.
- Automating the invitation process for signers with customized authentication methods.
- Controlling signer permissions such as locking their ability to change name/email/phone.
- Enforcing additional identity verification steps like CPF validation, selfie validation, or document authentication.
Practical example:
- You have a document token representing a contract. Using this node, you add a signer by providing their email, name, and preferred authentication method (e.g., SMS token). The signer then receives an automatic invitation to sign the document securely.
Properties
| Name | Meaning |
|---|---|
| Document Token | Token of the document to which the signer will be added. |
| Signer Email | Email address of the signer. |
| Signer Name | Full name of the signer. |
| Authentication Method | Method used to authenticate the signer. Options: • Assinatura Na Tela (On-screen signature) • Token Por Email (Email token) • Assinatura Na Tela + Token Por Email • Token Por SMS • Assinatura Na Tela + Token Por SMS • Token Por WhatsApp • Assinatura Na Tela + Token Por WhatsApp • Certificado Digital (Digital certificate) • Nenhum (None) |
| Redirect Link | URL to redirect the signer after completing the signature. |
| Phone Country Code | Country code for phone number (e.g., "55" for Brazil). Required if using SMS or WhatsApp authentication methods. |
| Phone Number | Phone number for SMS or WhatsApp authentication. |
| Lock Name | Boolean flag to prevent the signer from changing their name. |
| Lock Email | Boolean flag to prevent the signer from changing their email. |
| Lock Phone | Boolean flag to prevent the signer from changing their phone number. |
| Qualification | Qualification text to appear in the signature report (e.g., "testemunha" meaning witness). |
| External ID | An identifier for the signer in your own application system. |
| Send Automatic Email | Whether to automatically send an invitation email to the signer upon adding them. |
| Send Automatic WhatsApp | Whether to automatically send an invitation via WhatsApp. |
| Send WhatsApp Signed File | Whether to send the signed file to the signer via WhatsApp after completion. |
| Require CPF | Whether the signer must provide their CPF (Brazilian individual taxpayer registry identification). |
| CPF | The CPF number of the signer. |
| Validate CPF | Whether to validate the CPF against the Receita Federal database. |
| Selfie Validation Type | Type of selfie validation to perform. Options: • None • Face Match (facematch) |
| Require Document Authentication | Whether to require the signer to upload an identification document during signing. |
| Require Facial Recognition | Whether to require facial recognition during signing. |
Output
The node outputs an array of JSON objects corresponding to each processed item. For the Signer - Add operation, the output JSON contains the response from the ZapSign API confirming the addition of the signer. This typically includes details about the newly added signer, such as their token, status, and any relevant metadata returned by the API.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the ZapSign API.
- The node uses environment variables to determine the base URL for the API (
ZAPSIGN_API_BASE_URL_SANDBOXfor sandbox orZAPSIGN_API_BASE_URLfor production). - Internet access is required to communicate with the ZapSign API endpoints.
Troubleshooting
Common Issues
- Missing or invalid document token: The document token must be valid and correspond to an existing document in ZapSign.
- Invalid or missing signer email: The signer email is required unless explicitly allowed to be blank.
- Incorrect phone country code or phone number: When using SMS or WhatsApp authentication, these fields must be correctly set.
- Authentication method mismatch: Ensure the chosen authentication method matches the provided contact information.
- CPF validation failures: If enabled, CPF must be valid and match official records.
- API errors due to permission or plan limitations: Some features may require specific ZapSign plans or permissions.
Error Messages
- 400 Bad Request: Usually indicates missing or invalid parameters such as document token, signer email, or authentication settings. Check all required fields and formats.
- 403 Forbidden: May indicate insufficient permissions or account restrictions.
- Network or connectivity errors: Verify internet connection and API endpoint accessibility.
To resolve errors:
- Double-check all required input properties.
- Validate email and phone formats.
- Confirm API credentials and environment configuration.
- Consult ZapSign API documentation for detailed error codes.
Links and References
- ZapSign API Documentation (official API docs)
- ZapSign Website
- n8n Documentation on Creating Custom Nodes