This section provides tutorials for document management and timestamping operations using the EBSI CLI. Learn how to create documents, apply timestamps, and manage document lifecycle in the EBSI ecosystem.

Document Management Overview

EBSI provides powerful document management capabilities through two main APIs:

• Document Creation: Create and register documents in the system using the Track and Trace API
• Timestamping: Apply cryptographic timestamps to ensure document integrity using the Timestamp API
• Document Tracking: Monitor document status and history through the Track and Trace API
• Verification: Verify document authenticity and timestamps through both APIs

Tutorial Categories

Document Creation

Learn how to create documents in the EBSI system using the Track and Trace API, including proper formatting and metadata management.

Timestamping

Understand how to apply timestamps to documents using the Timestamp API, ensuring their integrity and providing proof of existence at specific points in time.

Key Concepts

Documents

Documents in EBSI are digital records that can represent various types of information, from certificates to official records.

Timestamps

Timestamps provide cryptographic proof that a document existed at a specific point in time, ensuring data integrity and preventing tampering.

Document Lifecycle

Understanding the complete lifecycle of documents from creation to verification and potential revocation.

Prerequisites

Before following these tutorials:

1. EBSI Access: Ensure you have access to the appropriate EBSI environment
2. User Credentials: Have valid user credentials for document operations
3. Node.js v22: Install the recommended Node.js version
4. Basic CLI Knowledge: Understand fundamental CLI commands
5. Wallet Setup: Complete wallet configuration if not already done

Getting Started

# Start the CLI
npx @cef-ebsi/cli

# Set your environment
env test  # or pilot/production

# Load your user credentials
using user ES256K did1 <private-key> <did>

# Verify access to document services
timestamp get /health
tnt get /health

Create a Document in Track and Trace

The Track and Trace API is used to timestamp documents and write events on top of them. The timestamp can be taken from the blockchain or can be linked to external sources with their corresponding proof. With this guide, you will be able to create a document, grant access to other accounts, and write events.

Read document

Create a Timestamp

The Timestamp API will help you to timestamp individual data, track document versions, and validate already existing timestamps.

Read document