Surense icon

Surense

Interact with Surense API

Actions36

Document → Download Har Bituach

AI-generated

Overview

The node named "Surense" provides an interface to interact with the Surense API, supporting multiple resources and operations. Specifically, for the Document resource and the Download Har Bituach operation, it allows users to download a security-related document associated with a customer. This is useful in scenarios where you need to programmatically retrieve official or compliance documents tied to a customer's identity.

Practical examples include:

  • Automatically fetching security clearance or insurance documents for customers in a workflow.
  • Integrating document retrieval into customer onboarding or verification processes.
  • Archiving or processing downloaded documents for audit or compliance purposes.

Properties

Name Meaning
מזהה לקוח (customerId) Customer ID in UUID format; identifies the customer whose document will be downloaded.
Additional Parameters Optional parameters to customize the request:
- תאריך קובץ (fileDate) File date (optional); specifies the date of the file to download if applicable.

Output

The node outputs JSON data representing the result of the document download operation. The exact structure depends on the API response but typically includes metadata about the document and possibly the document content or a link to it.

If the document contains binary data (e.g., PDF or other file formats), the node would handle this as binary output, allowing subsequent nodes to process or save the file accordingly.

Dependencies

  • Requires an active connection to the Surense API via an OAuth2 API credential.
  • The node depends on the Surense API being accessible and the provided credentials having sufficient permissions to perform document downloads.
  • No additional environment variables are explicitly required beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing customer ID (UUID): Ensure the customerId property is correctly set and formatted.
    • Authentication failures: Verify that the OAuth2 credential is valid and has not expired.
    • Network or API errors: Check connectivity and Surense API status.
    • Missing or incorrect optional parameters may cause the API to return no data or errors.

  • Error messages:

    • Errors thrown by the API will be caught and can be output as error JSON if "Continue On Fail" is enabled.
    • Typical error messages might include "Customer not found," "Unauthorized," or "Invalid date format."

  • Resolution tips:

    • Double-check input parameters for correctness.
    • Refresh or reconfigure API credentials if authentication fails.
    • Use the node's error output to debug specific API response messages.

Links and References

Discussion