Developer Docs

Documentation

Everything you need to integrate with Verda. API reference, SDKs, webhooks, and best practices for building on our supply chain transparency protocol.

Quick Start GitHub

explore

Documentation

API Reference

RESTful API endpoints for products, journeys, and verification.

SDKs & Libraries

Client libraries for JavaScript, Python, Go, and Rust.

Webhooks

Real-time notifications for journey events and alerts.

Integration Guides

Step-by-step tutorials for common integration patterns.

quick start

Get Started in 5 Minutes

1. Get API Keys

Request access through our developer portal. You'll receive a test API key immediately.

export VERDA_API_KEY="vrd_test_xxxxxxxxxxxx"

2. Install SDK

Install the SDK for your preferred language.

# Node.js
npm install @verda/sdk

# Python
pip install verda-sdk

# Go
go get github.com/verda-protocol/verda-go

3. Make Your First Request

Fetch a product journey with a single API call.

import { Verda } from '@verda/sdk';

const verda = new Verda({ apiKey: process.env.VERDA_API_KEY });

// Get product journey by QR code
const journey = await verda.products.getJourney('PRD-2024-001234');
console.log(journey.events);

4. Verify On-Chain

Cryptographically verify the journey against the blockchain.

// Verify Merkle proof
const isValid = await verda.verify.merkleProof(
  journey.events[0],
  journey.merkleProof
);
console.log('Verified:', isValid); // true

api

API Reference

Base URL: https://api.verda.so/v1

Products

GET  /products/:id           # Get product details
GET  /products/:id/journey   # Get full journey
POST /products               # Register new product
PUT  /products/:id           # Update product

Product endpoints for registering and querying product data.

Events

POST /events                 # Record new event
GET  /events/:id             # Get event details
GET  /events/:id/proof       # Get Merkle proof

Event endpoints for recording and querying supply chain events.

Verification

POST /verify/merkle          # Verify Merkle proof
GET  /verify/batch/:id       # Get batch anchor status
GET  /verify/blockchain/:tx   # Get Blockchain transaction

Verification endpoints for cryptographic proof validation.

Sensors

GET  /sensors/:id            # Get sensor info
GET  /sensors/:id/readings   # Get sensor readings
POST /sensors/:id/readings   # Submit readings

IoT sensor endpoints for temperature and location data.

sdks

SDKs & Libraries

🟨

JavaScript / TypeScript

@verda/sdk

Full-featured SDK for Node.js and browser environments.

GitHub

🐍

Python

verda-sdk

Async-first SDK with type hints and Pydantic models.

GitHub

🔵

Go

verda-go

Idiomatic Go client with context support and retries.

GitHub

🦀

Rust

verda-rs

Zero-cost abstractions. Used in our own services.

GitHub

webhooks

Webhooks

Receive real-time notifications when events occur in your supply chain. Configure webhook endpoints in the dashboard.

Available Events

product.created — New product registered
event.recorded — New journey event recorded
sensor.alert — Temperature or condition alert
batch.anchored — Batch anchored to Blockchain
recall.initiated — Recall process started

Webhook Payload

{
  "id": "evt_xxxxxxxxxxxx",
  "type": "sensor.alert",
  "created": "2024-03-15T06:30:00Z",
  "data": {
    "sensor_id": "SNS-001234",
    "alert_type": "temperature_excursion",
    "value": 8.5,
    "threshold": 4.0,
    "product_id": "PRD-2024-001234"
  }
}

guides