ZapSign

Overview

The node integrates with the ZapSign API to manage electronic document signing workflows. Specifically, for the Signer - Update operation, it updates the details of an existing signer associated with a document. This includes modifying the signer's name, email, authentication method, contact information, and various validation and locking options.

This operation is useful when you need to correct or change signer information after they have been added but before the signing process is complete. For example, if a signer's email address changes or you want to enforce stricter authentication methods, this update allows those adjustments without recreating the entire document or signer.

Practical examples:

• Updating a signer's email if it was entered incorrectly.
• Changing the authentication method from email token to SMS token.
• Locking the signer's phone number to prevent further edits.
• Enabling facial recognition or document authentication requirements for enhanced security.

Properties

Output

The node outputs an array of JSON objects representing the response from the ZapSign API for each processed item. For the Signer - Update operation, the output JSON typically contains the updated signer details as returned by the API, including confirmation of the changes made.

No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "signer_token": "abc123",
  "name": "Updated Signer Name",
  "email": "new.email@example.com",
  "auth_mode": "tokenEmail",
  "phone_country": "55",
  "phone_number": "11999999999",
  "lock_name": true,
  "lock_email": false,
  "qualification": "testemunha",
  "send_automatic_email": true,
  ...
}

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_SANDBOX for sandbox or ZAPSIGN_API_BASE_URL for production).
• Network access to the ZapSign API endpoints is required.

Troubleshooting

Common Issues

• Missing or invalid signer token: The signer token must be provided and valid; otherwise, the API will reject the request.
• Invalid email format: If updating the email, ensure it is correctly formatted.
• Authentication method conflicts: Some authentication methods require phone country code and phone number; missing these fields can cause errors.
• CPF validation failures: If CPF validation is enabled, the CPF must be valid and match official records.
• API connectivity issues: Network problems or incorrect API base URLs can cause request failures.

Common Error Messages

• 400 Bad Request: Usually indicates missing required fields, invalid parameter values, or malformed requests. Check that all required properties are set correctly and that optional fields comply with expected formats.
• 401 Unauthorized / 403 Forbidden: Indicates issues with API credentials or permissions.
• Signer Token Required: If the signer token is missing or empty, the node throws an error indicating this requirement.
• Validation Errors: Errors related to CPF or phone number validation may occur if data does not meet expected formats or external validation fails.

How to Resolve

• Verify all required inputs are provided and correctly formatted.
• Ensure the API key credential is valid and has necessary permissions.
• Confirm that phone-related fields are provided when using SMS or WhatsApp authentication.
• Disable CPF validation if not needed or provide a valid CPF.
• Review API documentation for any constraints on field values.

Links and References

• ZapSign API Documentation (official API docs for detailed endpoint info)
• ZapSign Authentication Methods (details on available signer authentication modes)
• CPF Validation Rules (background on CPF format and validation)

If you need summaries for other resources or operations, please provide the relevant details.