API Reference

REST API for on-chain compliance and risk assessment.

Base URL

https://api.fidesorigin.com/api/v1

Authentication

All API requests require a Bearer token in the Authorization header.

Header

Authorization: Bearer YOUR_API_KEY

Endpoints

GET /addresses/{address}

Get risk profile for a specific Ethereum address.

Response

JSON

{
  "address": "0x...",
  "risk_score": 85,
  "risk_tier": "HIGH",
  "is_sanctioned": false,
  "tags": ["mixer", "high_volume"],
  "entity_name": "Unknown",
  "last_updated": "2026-07-24T09:00:00Z"
}

POST /risk-assessment

Submit a transaction for risk assessment before execution.

Request Body

JSON

{
  "from": "0x...",
  "to": "0x...",
  "amount": "1000000000000000000",
  "asset": "0x..."
}

Response

JSON

{
  "allowed": true,
  "risk_score": 15,
  "risk_tier": "LOW",
  "quarantine_required": false,
  "reason": null
}

GET /rules

List all active compliance rules.

Response

JSON

{
  "rules": [
    {
      "id": "rule-001",
      "name": "Sanctions Screening",
      "type": "BLOCK",
      "active": true,
      "priority": 1
    }
  ]
}

Error Codes

Code	Status	Description
`400`	Bad Request	Invalid request parameters
`401`	Unauthorized	Missing or invalid API key
`404`	Not Found	Address or resource not found
`429`	Rate Limited	Too many requests
`500`	Server Error	Internal server error