code REST API v1

Developer API

Integrate blockchain certification and traceability into your applications. Complete documentation and usage examples.

Base URL:


                https://api.proovik.com/v1

verified

Certification

Seal documents on the blockchain

POST /certify Certify a document

Submits a file hash to be recorded on the Kaspa blockchain. Returns a transaction ID and certificate data.

# Request

curl -X POST https://api.proovik.com/v1/certify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hash": "e3b0c44298fc1c149afbf4c8996fb924...",
    "filename": "contract.pdf",
    "metadata": {"client": "Acme Corp"}
  }'

GET /verify/{hash} Verify a document

Checks if a file hash exists on the blockchain and returns its certification details.

# Response

{
  "verified": true,
  "txid": "abc123...",
  "timestamp": "2026-01-06T12:00:00Z",
  "block_hash": "...",
  "merkle_proof": [...]
}

conversion_path

Traceability

Chain of custody with Hash Chaining

POST /trace/batch Create batch

Creates a new product batch to track. Returns a unique batch ID for subsequent events.

{
  "batch_id": "BATCH-2026-001",
  "product": "Organic Olive Oil",
  "origin": "Jaén, Spain",
  "metadata": {...}
}

POST /trace/event Add event

Adds a new event to the batch chain. Automatically links to the previous event via Hash Chaining.

{
  "batch_id": "BATCH-2026-001",
  "event_type": "HARVEST",
  "evidence_hash": "sha256:...",
  "location": { "lat": 37.77, "lng": -3.79 },
  "data": { "weight_kg": 500, "quality": "A" }
}

info The event is automatically chained to the previous TXID, creating an unbreakable sequence.

GET /trace/batch/{batch_id} Get batch history

Returns the complete event chain for a batch, with blockchain verification status for each event.

{
  "batch": {...},
  "events": [
    { "type": "SOWING", "txid": "...", "verified": true },
    { "type": "HARVEST", "txid": "...", "verified": true },
    { "type": "TRANSPORT", "txid": "...", "verified": true }
  ],
  "chain_valid": true
}

webhook

Webhooks

Real-time notifications

Receive instant notifications when transactions are confirmed on the blockchain.

certification.confirmed

Document certified

trace.event.confirmed

Traceability event confirmed

SDKs

🐍 Python Coming Soon

🟨 JavaScript Coming Soon

🐘 PHP Coming Soon

🔵 Go Coming Soon

Ready to integrate?

mail Request API Access conversion_path Learn about Traceability