ZapSign

Overview

This node integrates with the ZapSign API to manage various document-related and background check operations. Specifically for the Background Check resource with the Get Check operation, it retrieves information about a previously created background check using a unique check token.

Common scenarios where this node is beneficial include:

• Verifying the status and results of a background check on a person or company.
• Automating workflows that depend on background verification outcomes.
• Integrating background check data retrieval into broader business processes such as hiring, compliance, or customer onboarding.

Practical example:

• After initiating a background check on a candidate, use this node to fetch the current status and details of that check by providing the check token. This allows automated decision-making based on the check's completion and findings.

Properties

Output

The node outputs a JSON object representing the background check data retrieved from the ZapSign API. The structure typically includes fields such as:

• Status of the background check (e.g., pending, completed).
• Details about the person or company checked.
• Results or findings of the background check.
• Metadata or custom inputs associated with the check.

If the background check is not found or inaccessible, an error is thrown indicating a 404 Not Found status.

No binary data output is produced by 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 for sandbox or ZAPSIGN_API_BASE_URL for production), defaulting to ZapSign's official endpoints if not set.
• Relies on network connectivity to call the ZapSign REST API endpoints.

Troubleshooting

Common Issues

• Invalid or expired check token: If the provided check token is incorrect, expired, or does not exist, the API returns a 404 error.
• Insufficient permissions: Access to background check features may require specific account permissions or plan upgrades.
• API endpoint changes: If the ZapSign API changes or deprecates endpoints, calls may fail.

Error Messages and Resolutions

• Background check not found (404 error):

  Background check not found (404 error).
  
  Possible causes:
  1. Invalid check token provided
  2. Background check may have expired or been deleted
  3. Check token format is incorrect
  4. You may not have access to this background check
  
  Please verify:
  - The check token is valid and correctly formatted (starts with "CHK")
  - The background check was created successfully
  - You have proper permissions to access this check
  

  Resolution:

  • Confirm the check token is correct and properly formatted.
  • Ensure the background check exists and is accessible.
  • Contact ZapSign support if unsure about permissions or feature availability.

• Network or authentication errors:

  Ensure the API key credential is valid and the environment variables for the API base URL are correctly configured.

Links and References

• ZapSign API Documentation (general reference for API endpoints and usage)
• ZapSign support contact for account and permission issues

Note: This summary focuses exclusively on the Background Check resource and the Get Check operation as requested. Other resources and operations are implemented but not described here.