DEVELOPER DOCUMENTATION

Build with VeritasZK.

REST API, TypeScript SDK, MCP server, and CLI. Integrate solvency verification into any application in minutes.

30-Second Quickstart

Verify any organization's solvency tier from your terminal in one command.

bash
npx veritaszk-cli verify --org DemoExchange

Expected output:

VeritasZK CLI v0.2.0

Organization : DemoExchange
Tier         : T4 Institutional
Coverage     : ≥ 3.0× (actual: 3.75×)
Status       : ACTIVE
Standard     : Basel III Advanced IRB
Verified at  : Block #15,613,711
Commitment   : a1b2c3d4e5f6...

✓ Solvency verified. No financial data disclosed.

Deployed Contracts

All 4 programs are live on Aleo Testnet. Verified on-chain.

veritaszk_registry.aleo

Organization identity, credentials, and delegation

Explorer ↗
TX:at1syv4aged4jk0gspqyadeq7sq40yga2x85kxc7pcyj60w9vydzczq3mj3at
TRANSITIONS (6)
register_orgissue_verifier_credentialdelegate_proverrevoke_credentialdelegate_proof_authorityregister_org_name
veritaszk_core.aleo

Proof generation, multi-wallet support, expiry, selective disclosure

Explorer ↗
TX:at19tn3me0tm5sct8q2a3zwz0ffkujtztz9td04psrjj3pmcencj5gse7yv3y
TRANSITIONS (10)
commit_positionprove_solvencyprove_solvency_multi_walletverify_solvencyselective_discloseprove_thresholdrevoke_proofrevoke_proof_recordsubmit_proof_with_expiryrefresh_proof
veritaszk_audit.aleo

Immutable audit trail and compliance disclosure records

Explorer ↗
TX:at1jqffrkx5tepef74nvqhmzscywg2ulx8p9ejf70gxj873l07lhgrqdhggfa
TRANSITIONS (5)
record_proof_eventflag_proof_expiredrecord_compliance_disclosurelog_verificationlink_proof_history
veritaszk_threshold.aleo

Multi-asset bundle threshold proofs and tier attestation

Explorer ↗
TX:at1j9ghj3zu5a9n47t07nsyj3uu6f5q6g54u8vn22gse68e428lacqq7ugnz4
TRANSITIONS (3)
prove_thresholdverify_tierrevoke_tier_proof

REST API

Base URL:

https://veritaszk-production.up.railway.app
...
GET/api/health

Indexer health, last indexed block, uptime, deployed programs

bash
curl https://veritaszk-production.up.railway.app/api/health
GET/api/stats

Total orgs, active/expired/revoked proof counts

bash
curl https://veritaszk-production.up.railway.app/api/stats
GET/api/proofs

All tracked commitments with proof status and tier

bash
curl https://veritaszk-production.up.railway.app/api/proofs
GET/api/proofs/:commitment

Single org proof details, tier, expiry, verification count

bash
curl https://veritaszk-production.up.railway.app/api/proofs/a1b2c3d4e5f6...
GET/api/tiers

Tier distribution (T1–T4 counts) across all organizations

bash
curl https://veritaszk-production.up.railway.app/api/tiers
POST/api/proofs/register

Register a new commitment for the indexer to track

bash
curl https://veritaszk-production.up.railway.app/api/proofs/register

TypeScript SDK

Full-featured SDK for verifying proofs, watching expiry, and batch-verifying organizations.

bash
npm install veritaszk-sdk

BATCH VERIFY FROM INDEXER

verify.ts
import { batchVerifyFromIndexer } from 'veritaszk-sdk'

const results = await batchVerifyFromIndexer([
  'DemoExchange',
  'TestFund',
  'SampleDAO',
])

results.forEach(r => {
  console.log(`${r.orgName}: Tier ${r.tier} — ${r.tierName}`)
  // DemoExchange: Tier 4 — Institutional
  // TestFund: Tier 3 — Strong
  // SampleDAO: Tier 2 — Verified
})

WATCH PROOF EXPIRY

watch.ts
import { watchProof } from 'veritaszk-sdk'

const unsubscribe = watchProof(commitment, (event) => {
  if (event.type === 'expiring') {
    console.log(`Proof expires in ${event.blocksRemaining} blocks`)
  }
  if (event.type === 'expired') {
    console.log('Proof has expired — renewal required')
  }
})

// Stop watching
unsubscribe()

CHECK EXPIRY STATUS

expiry.ts
import { isProofExpiredFromIndexer } from 'veritaszk-sdk'

const expired = await isProofExpiredFromIndexer(commitment)
if (expired) {
  console.log('Proof has expired — request renewal from organization')
}

MCP Server

Drop veritaszk-mcp into Claude Desktop to query solvency status from natural language.

bash
npm install veritaszk-mcp

CLAUDE DESKTOP CONFIGURATION

claude_desktop_config.json
// claude_desktop_config.json
{
  "mcpServers": {
    "veritaszk": {
      "command": "npx",
      "args": ["veritaszk-mcp"],
      "env": {
        "VERITASZK_INDEXER": "https://veritaszk-production.up.railway.app"
      }
    }
  }
}

AVAILABLE TOOLS

check_org_solvency

Check the current solvency tier for a named organization or commitment hash.

list_expiring_proofs

List all proofs expiring within a specified time window (default 72h).

CLI

Terminal-based verification for CI pipelines and operator workflows.

bash
npm install -g veritaszk-cli

Verify solvency tier for a named organization

bash
veritaszk verify --org DemoExchange

Verify by commitment hash

bash
veritaszk verify --commitment a1b2c3...

List all active proofs from the indexer

bash
veritaszk list --active

Watch a proof for expiry events (streams updates)

bash
veritaszk watch --org DemoExchange

Show network-wide solvency statistics

bash
veritaszk stats

Architecture

CPI flow between the four deployed Leo programs.

PROGRAM DEPENDENCY GRAPH

veritaszk_registry.aleo

identity & credentials

↓ validates

veritaszk_core.aleo

proof engine · central hub

↙ audit events

veritaszk_audit.aleo

compliance trail

↘ tier proofs

veritaszk_threshold.aleo

asset bundles

CPI Note

Registry validation is enforced at the application layer due to a Leo v4.0.0 CPI finalize mapping read compiler limitation. Import statements remain in core for architectural clarity. CPI cross-program invocation is fully planned for the next Leo release.