Quickstart

Make your first Overvoid API call in 5 minutes.

1. Get an API Key

Go to the API Keys page and create a new key. Select test environment and the scopes you need (e.g. read, compliance). Your key will look like:

cusd_test_7kB9mR2xPqLw...

Copy it immediately — it will only be shown once.

Test keys hit the same API as live keys but return sandbox data — mock screening results, no real blockchain freezes, no FinCEN submissions. When you're ready for production, just swap in a cusd_live_ key. No code changes needed.

2. Screen an Entity

Run a sanctions screening check against an entity name:

Request
curl -X POST https://api.overvoid.io/v1/compliance/screen \
  -H "Authorization: Bearer cusd_test_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp", "jurisdiction": "US-DE"}'
Response
{
  "entity_name": "Acme Corp",
  "jurisdiction": "US-DE",
  "sanctions_hit": false,
  "pep_hit": false,
  "adverse_media_hit": false,
  "risk_score": 12
}

3. Check On-Chain Compliance

Query the on-chain compliance oracle for a wallet address:

Request
curl https://api.overvoid.io/v1/chain/compliance/11155111/0x2652e0aeE99148D1abdf3B715349f5Bc23C5DC0a \
  -H "Authorization: Bearer cusd_test_YOUR_KEY_HERE"
Response
{
  "chain_id": 11155111,
  "address": "0x2652e0aeE99148D1abdf3B715349f5Bc23C5DC0a",
  "flags": "31",
  "kyb_expiry": 1741305600,
  "ubo_expiry": 1741305600,
  "aml_expiry": 1741305600,
  "sanctions_expiry": 1741305600,
  "entity_id_hash": "0xabc..."
}

4. Create an Entity

Register a B2B counterparty entity for KYB:

curl -X POST https://api.overvoid.io/v1/onboarding/entities \
  -H "Authorization: Bearer cusd_test_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "legal_name": "Acme Corp",
    "jurisdiction": "US-DE",
    "entity_type": "corporation",
    "wallets": [{
      "chain_id": 11155111,
      "address": "0x1234567890abcdef1234567890abcdef12345678"
    }]
  }'

Next Steps

  • Authentication — Learn about API key scopes and environments
  • Onboarding — KYB entity creation and wallet registration
  • Webhooks — Get notified about events in real-time
  • API Reference — Full reference for all 27 partner-facing endpoints