1. Document Operations

Document Operations Overview

Document operations are the core functionality of the Circularo platform, enabling users to create, store, retrieve, modify, and process documents throughout their lifecycle. This section provides comprehensive guidance on all aspects of document operations.

Document Lifecycle

Documents in Circularo follow a complete lifecycle:

• Creation: Upload external files or generate documents from templates

• Enrichment: Add metadata, annotations, and attachments

• Processing: Sign, seal, or certify documents

• Retrieval: Search, download, and view documents

• Deletion: Remove documents when no longer needed

Key Document Concepts

• Metadata Definitions: Templates that define the structure and fields of documents

• Workflow Definitions: Processes that define the lifecycle and states of documents

• Document Templates: Reusable configurations for creating similar documents

• File Management: Handling of document content and attachments

• Digital Signatures: Cryptographic protection for document authenticity and integrity

Basic Document Operations

• Document Creation: Upload files and create documents with metadata

• Document Retrieval: Fetch documents by ID or search criteria

• Document Modification: Update document metadata and content

• Document Deletion: Remove documents when no longer needed

Advanced Document Features

• Document Search: Find documents using powerful query capabilities

• Document Scrolling: Process large sets of documents efficiently

• Document Annotation: Add notes, highlights, and markups to documents

• Document Signing and Sealing: Apply cryptographic protection to documents

• Document Templates: Create reusable document configurations

Best Practices

• Use appropriate metadata definitions for different document types

• Implement consistent naming conventions for documents

• Leverage templates for frequently created document types

• Use document search capabilities for efficient document retrieval

Document operations may require specific permissions. Ensure your authentication token has the necessary rights to perform the desired operations.

All document operations require a valid authentication token. See the Authentication & Security section for details on obtaining and managing tokens.

Getting Started

The scenarios in this section demonstrate the full range of document operations capabilities:

• Start with basic document creation to understand the fundamental concepts

• Explore document retrieval and search to efficiently find documents

• Learn about document signing and annotation for advanced document processing

• Discover document templates for streamlining repetitive document creation