5 minutes

Quickstart.
API key in 60 seconds.

Get your API key, install the SDK, and screen your first address in under five minutes.

Quickstart

Five steps. One integration.

Sign up, install, screen, score, and ship. The SDK handles authentication and retry automatically.

1. Get your API key

Sign up at useveris.finance/developers. Navigate to API Keys in the developer dashboard and generate a new key. The key starts with vrs_sk_live_ for production or vrs_sk_test_ for sandbox.

  • Create your account at useveris.finance/developers/signup
  • Open Settings > API Keys in the dashboard
  • Click Generate Key and copy the value
  • Store the key in a secure location. It will not be shown again.

2. Install the SDK

Veris provides official SDKs for Python and TypeScript. Pick the one that fits your stack.

# Python
pip install veris-sdk

# TypeScript / Node.js
npm install @veris/sdk

3. Screen your first address

Pass an on-chain address and chain identifier to the screen method. The response includes sanctions match status, the matched list name, and a confidence score.

from veris import Veris
client = Veris(api_key="vrs_sk_live_...")
result = client.screen(
    address="0x7Ff9...D4eA",
    chain="ethereum"
)
print(result.status)      # "match" or "clear"
print(result.list)        # "OFAC SDN"
print(result.confidence)  # 0.998

4. Check the risk score

The risk method returns a calibrated probability from a 15-model ensemble. The response includes per-feature SHAP attribution and individual detector outputs.

risk = client.risk("0x7Ff9...D4eA", chain="ethereum")
print(risk.score)          # 0.94
print(risk.detectors)      # 7 detector outputs
print(risk.shap_values)    # per-feature attribution

5. Next steps

You have a working integration. Explore the rest of the platform to build a complete compliance pipeline.

  • API Reference — All 16 endpoints with request and response schemas
  • Webhooks — Subscribe to alerts, status changes, and SAR filings
  • Sandbox — Test with simulated OFAC data and risk scores
Keep going

From quickstart to production.

API key in hand? Move to the API reference, or explore the integration guides.