API Documentation

Getting Started

zkOrigoPlus API provides real-time blockchain compliance validation across 6 major networks with AI-powered advisory scores.

Base URL

https://j93fplla56.execute-api.ap-southeast-2.amazonaws.com/prod/v1

Authentication

Include the API key in request headers:

x-api-key: demo-key

Endpoints

GET /healthz

Check API health status

POST /validate

Validate wallet compliance across multiple modules

Validation Request

POST /validate

Request Body:

{ "chain": "hedera", "wallet": "0.0.2", "modules": ["aml", "iso", "rwa", "zk", "kyc", "cbp"] }

Parameters

  • chain (string): Blockchain network - hedera, ethereum, bitcoin, polygon, stellar, xrpl
  • wallet (string): Wallet address to validate
  • modules (array): Compliance modules to check

Response Format

{ "deterministic_score": 0.85, "advisory_aml": 0.78, "advisory_iso": 0.72, "advisory_rwa": 0.81, "advisory_zk": 0.76, "advisory_kyc": 0.74, "advisory_cbp": 0.79, "timestamp": 1762863193, "region": "ap-southeast-2", "modules_requested": ["aml", "iso", "rwa", "zk", "kyc", "cbp"], "mode": "LIVE", "ai_enabled": true, "balance": "16,630,126.38 HBAR", "wallet_age": "1818 days", "recent_transactions": [ { "hash": "0.0.2-176003...", "type": "NODEUPDATE", "amount": "0.0000 HBAR", "timestamp": "1760034545" } ] }

Supported Chains

  • hedera - Hedera Hashgraph (HBAR)
  • ethereum - Ethereum (ETH)
  • bitcoin - Bitcoin (BTC)
  • polygon - Polygon (MATIC)
  • stellar - Stellar (XLM)
  • xrpl - XRP Ledger (XRP)

Compliance Modules

  • aml - Anti-Money Laundering
  • iso - ISO20022 Compliance
  • rwa - Real World Assets
  • zk - Zero-Knowledge Proofs
  • kyc - Know Your Customer
  • cbp - Cross-Border Payments

Example Usage

cURL

curl -X POST https://j93fplla56.execute-api.ap-southeast-2.amazonaws.com/prod/v1/validate \ -H "Content-Type: application/json" \ -H "x-api-key: demo-key" \ -d '{ "chain": "hedera", "wallet": "0.0.2", "modules": ["aml", "kyc"] }'

JavaScript

const response = await fetch('https://j93fplla56.execute-api.ap-southeast-2.amazonaws.com/prod/v1/validate', { method: 'POST', headers: { 'Content-Type': 'application/json', 'x-api-key': 'demo-key' }, body: JSON.stringify({ chain: 'hedera', wallet: '0.0.2', modules: ['aml', 'kyc'] }) }); const data = await response.json();

Rate Limits

  • Demo API key: 100 requests per hour
  • Timeout: 10 seconds per request
  • Max payload: 1MB