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 perform various operations related to digital document management, signing workflows, templates, webhooks, partnerships, timestamps, and background checks. Specifically, for the Background Check resource with the Create Company Check operation, the node allows users to initiate a background check on a company by providing its CNPJ (Brazilian company tax ID). This is useful in scenarios such as due diligence, risk assessment, or compliance verification where automated company background verification is required.
Practical example: A user wants to verify the legitimacy and status of a supplier company before onboarding them. By providing the company's CNPJ and optionally the company name and an external identifier, the node creates a background check request via the ZapSign API. The node can either force creation of a new check or return an existing one if available.
Properties
| Name | Meaning |
|---|---|
| External ID | Your external identifier for the check (optional). Useful for correlating with your own system. |
| Company Document (CNPJ) | The CNPJ number of the company to check. This is a required field. |
| Company Name | Name of the company (optional). |
| Force Creation | Boolean flag indicating whether to force creation of a new check even if one already exists (true), or to return an existing result (false). |
Output
The node outputs JSON data representing the response from the ZapSign API for the background check request. This typically includes details about the created or retrieved background check, such as tokens, status, and any relevant metadata returned by the API.
No binary data output is produced for this operation.
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(default:https://sandbox.api.zapsign.com.br)ZAPSIGN_API_BASE_URL(default:https://api.zapsign.com.br)
- The node uses internal helper functions to make HTTP requests and handle responses.
Troubleshooting
Common Issues
404 Not Found Error:
Indicates that the Background Check feature may not be enabled or available on your ZapSign account. Possible causes include:- Your plan does not include background checks.
- You lack necessary permissions or need an account upgrade.
- The API endpoint has changed or been deprecated.
- The provided CNPJ is invalid or not found.
Invalid Input Errors:
Ensure the CNPJ is correctly formatted and valid. If using the optional external ID or company name, verify their correctness.
Error Messages and Resolutions
Background Check feature not available (404 error):
Background Check feature not available (404 error). Possible causes: 1. Background checks may not be included in your ZapSign plan 2. This feature may require additional permissions or account upgrade 3. The API endpoint may have changed or been deprecated 4. Your ZapSign account may not have access to this feature Please contact ZapSign support to verify if background checks are available for your account.Resolution: Contact ZapSign support to confirm feature availability and permissions.
General API Request Failures:
Network issues, invalid credentials, or malformed requests can cause errors. Verify API keys, network connectivity, and input parameters.
Links and References
- ZapSign API Documentation (general reference for API endpoints and usage)
- Brazilian CNPJ Information (for understanding company tax IDs)
Note: This summary focuses exclusively on the "Background Check" resource and the "Create Company Check" operation as requested.