API Developer Portal

Comprehensive documentation for ComplianceOS APIs

Endpoints

45

API Version

v1.0

Uptime

99.9%

Avg Response

187ms

POST
/api/v1/screening/person

Screen Individual

Screen an individual against global sanctions, PEP, and watchlists

Authentication: Bearer Token
Rate Limit: 1000 req/min

Request Body

json
{
  "name": "Ahmed Al-Rashid",
  "date_of_birth": "1975-03-15",
  "nationality": "UAE",
  "passport_number": "A12345678",
  "aliases": [
    "Ahmed Rashid",
    "A. Al Rashid"
  ],
  "screening_lists": [
    "OFAC",
    "UN",
    "EU",
    "UAE"
  ],
  "fuzzy_threshold": 80,
  "check_ownership": true
}

Response

json
{
  "screening_id": "SCR-2025-0014892",
  "timestamp": "2025-01-15T10:23:45Z",
  "status": "MATCH_DETECTED",
  "risk_score": 87,
  "risk_level": "HIGH",
  "matches": [
    {
      "match_type": "name",
      "list": "OFAC_SDN",
      "confidence": 91,
      "matched_entity": "AHMED AL-RASHIDI",
      "entry_id": "OFAC-SDN-12345"
    }
  ],
  "processing_time_ms": 234,
  "ai_confidence": 87,
  "recommended_action": "ESCALATE"
}
POST
/api/v1/screening/company

Screen Company

Screen a company for sanctions, ownership, and compliance risks

Authentication: Bearer Token
Rate Limit: 500 req/min

Request Body

json
{
  "company_name": "Falcon Trading LLC",
  "registration_number": "CR-2024-001234",
  "country": "UAE",
  "check_ubo": true,
  "screening_lists": [
    "OFAC",
    "UN"
  ]
}

Response

json
{
  "screening_id": "SCR-2025-0014893",
  "status": "CLEAR",
  "risk_score": 12,
  "risk_level": "LOW",
  "ubo_results": [
    {
      "name": "John Smith",
      "risk_score": 15,
      "status": "CLEAR"
    }
  ]
}
POST
/api/v1/screening/wallet

Screen Crypto Wallet

Screen blockchain wallet addresses for illicit activity

Authentication: Bearer Token
Rate Limit: 2000 req/min

Request Body

json
{
  "wallet_address": "1A1z7agoat...",
  "blockchain": "bitcoin",
  "check_sanctions": true
}

Response

json
{
  "screening_id": "SCR-2025-0014894",
  "status": "MATCH_DETECTED",
  "risk_score": 78,
  "risk_level": "HIGH"
}
POST
/api/v1/screening/bulk

Bulk Screening

Screen multiple entities in one request

Authentication: Bearer Token
Rate Limit: 100 req/min

Request Body

json
{
  "entities": [
    {
      "type": "person",
      "name": "Ahmed Al-Rashid"
    },
    {
      "type": "company",
      "name": "Falcon Trading LLC"
    }
  ]
}

Response

json
{
  "batch_id": "BATCH-2025-0089",
  "total_entities": 2,
  "completed": 2,
  "results": []
}

Code Examples

curl
curl -X POST https://api.complianceos.com/api/v1/screening/person \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ahmed Al-Rashid",
    "date_of_birth": "1975-03-15",
    "nationality": "UAE"
  }'

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header.

Header Format

Authorization: Bearer YOUR_API_KEY

Use your sandbox environment for testing. All data in sandbox is isolated and test-only.

Sandbox
Production

HTTP Status Codes

CodeDescription
200OK - Request successful
201Created - Resource created successfully
400Bad Request - Invalid parameters
401Unauthorized - Missing or invalid API key
403Forbidden - Insufficient permissions
404Not Found - Resource not found
422Validation Error - Data validation failed
429Rate Limit Exceeded - Too many requests
500Internal Server Error - Server error

Webhooks

Subscribe to webhook events to receive real-time notifications about your data.

Available Events

  • • screening.complete
  • • kyc.approved
  • • case.updated
  • • report.generated

Payloads are signed with HMAC SHA-256 for verification. Retries are automatic on 5xx errors.