Viridem icon

Viridem

Interact's with Viridem

Actions77

Document Anchors → Get State Document Anchor

AI-generated

Overview

This node operation retrieves the state of a specific Document Anchor within a company. It is useful for scenarios where you need to fetch detailed information or status about a particular document anchor identified by its ID within a given company context. For example, it can be used in document management workflows to verify or audit the state of document anchors.

Use Case Examples

  1. Fetch the state of a document anchor by providing the company ID and the document anchor ID to monitor document processing status.
  2. Use in automated workflows to trigger actions based on the state of a document anchor retrieved from the system.

Properties

Name Meaning
Company Id The unique identifier of the company to which the document anchor belongs.
Document Anchor Id The unique identifier of the document anchor whose state is to be retrieved.
Request Options Additional settings to control the request behavior such as batching, SSL certificate validation, proxy usage, and timeout settings.

Output

JSON

  • companyId - The ID of the company associated with the document anchor.
  • documentAnchorId - The ID of the document anchor retrieved.
  • state - The current state or status information of the document anchor.
  • details - Additional details or metadata related to the document anchor state.

Dependencies

  • An API key credential for authentication to the Viridem API service.

Troubleshooting

  • Ensure that the provided Company Id and Document Anchor Id are correct and exist in the system to avoid 'not found' errors.
  • Check network connectivity and proxy settings if requests time out or fail to connect.
  • If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option cautiously.
  • Verify that the API credentials are valid and have the necessary permissions to access document anchor data.

Discussion