ZapSign

Overview

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

Use cases include:

• Verifying detailed results of a person's or company's background check.
• Automating workflows that require validation of background check status and details before proceeding.
• Fetching comprehensive background check data for compliance or record-keeping purposes.

Example: After creating a background check for a candidate, you can use this operation to fetch the detailed report once the check is completed.

Properties

Output

The node outputs a JSON object containing the detailed information of the specified background check. This includes all available data returned by the ZapSign API's /checks/{checkToken}/details/ endpoint, such as status, results, timestamps, and any other metadata related to the background check.

No binary data output is involved in 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 fallback: https://sandbox.api.zapsign.com.br)
  • ZAPSIGN_API_BASE_URL (default fallback: https://api.zapsign.com.br)
• The node makes HTTP GET requests to the ZapSign API endpoint /api/v1/checks/{checkToken}/details/.

Troubleshooting

Common Issues

• Invalid or expired check token: If the provided check token is incorrect, expired, or does not exist, the API will return a 404 error.
• Access permissions: Lack of proper permissions or account limitations may prevent access to background check details.
• Check not completed: Details may only be available after the background check has been fully processed and completed.

Error Messages

• Background check details not found (404 error):
  Possible causes:

  • Invalid check token format or value.
  • Background check expired or deleted.
  • Insufficient permissions to access the check.
  • The check is still in progress and details are not yet available.

  Resolution:
  Verify the check token is correct and starts with "CHK". Ensure the background check process has completed successfully. Confirm your account has access rights to view the check details.

Links and References

• ZapSign API Documentation - Background Checks (Note: link is illustrative based on typical API docs structure)