API Reference
RESTful API with predictable resource-oriented URLs and standard HTTP response codes.
Authentication
All API requests require a Bearer token in the Authorization header.
Authorization: Bearer YOUR_API_KEY
Endpoints
| Method | Endpoint | Description |
|---|
| POST | /v1/screen | Screen a wallet address for sanctions and risk |
| GET | /v1/health | Check API health and latency |
| GET | /v1/usage | Get API usage statistics for your account |
| POST | /v1/batch | Screen multiple wallets in a single request |
Response Format
All responses return JSON with a consistent structure.
{
"status": "CLEAN" | "BLOCKED" | "REVIEW",
"risk_score": 0.0 - 1.0,
"entity": {
"name": "string",
"type": "INDIVIDUAL" | "EXCHANGE" | "SANCTIONED_ENTITY",
"verified": boolean
},
"sanctions": [...],
"recommendation": "PROCEED" | "REJECT_TRANSACTION" | "ENHANCED_DUE_DILIGENCE",
"latency_ms": number
}