Objects & Models

Error object

{
  "ok": false,
  "error": "invalid_api_key",
  "message": "Unknown, expired, or revoked API key."
}

Screening response object

{
  "results": [
    {
      "input": "Northshore Trading GmbH",
      "name": "Northshore Trading GmbH",
      "isSanctioned": false,
      "directNameHit": false,
      "countryRiskHit": true,
      "actionableHit": true,
      "decision": {
        "status": "BLOCK",
        "label": "Do not proceed",
        "headline": "Sanctions concerns identified. Do not proceed.",
        "focus": "Country risk block with clean name screening",
        "reason": "The submitted subject name did not return direct list matches, but the case still requires a sanctions decision because the provided country information carries independent risk.",
        "recommendedNextSteps": [
          "Do not proceed with the case."
        ]
      },
      "matches": []
    }
  ],
  "policyMatches": [],
  "scannedSources": ["ofac_sdn", "eu", "uk"],
  "unavailableSources": [],
  "meta": {
    "tookMs": 120,
    "tenantId": "org_123",
    "planKey": "pro",
    "sourceSelection": {
      "mode": "settings",
      "appliedSources": ["un", "eu", "ofac", "uk", "seco"],
      "settingsStore": "user_settings"
    },
    "countryRisk": {
      "provided": true,
      "evaluated": true,
      "recommendation": "BLOCK",
      "riskLevel": "HIGH",
      "resolvedCountryName": "Syrian Arab Republic",
      "resolvedCountryIso2": "SY",
      "jurisdiction": "US",
      "reasons": ["Jurisdiction profile (US) lists SY as blocked."]
    }
  }
}

Cross-border risk object

{
  "resolved": {
    "country_name": "Germany",
    "country_iso2": "DE",
    "resolution_method": "LOCATION",
    "confidence": "HIGH",
    "city": "Munich",
    "region": "Bavaria"
  },
  "assessments": {
    "sanctions": { "recommendation": "ALLOW", "risk_level": "LOW", "reasons": [] },
    "aml": { "recommendation": "ALLOW", "risk_level": "LOW", "reasons": [] },
    "governance": { "recommendation": "CAUTION", "risk_level": "MEDIUM", "reasons": [] }
  },
  "final": {
    "recommendation": "CAUTION",
    "risk_level": "MEDIUM",
    "reasons": ["..."]
  },
  "meta": { "tookMs": 95, "tenantId": "org_123", "planKey": "pro" }
}

Case object

{
  "id": "case_123",
  "organization_id": "org_123",
  "title": "Potential sanctions match",
  "subject_name": "Ali Hassan",
  "status": "open",
  "risk_level": "high",
  "assigned_to": "user_456",
  "created_at": "2026-02-21T10:00:00.000Z",
  "updated_at": "2026-02-21T10:05:00.000Z"
}

Usage summary object

{
  "planKey": "pro",
  "included": 3000,
  "used": 123,
  "remaining": 2877,
  "periodStartIso": "2026-02-01T00:00:00.000Z",
  "periodEndIso": "2026-03-01T00:00:00.000Z"
}

Dataset object

{
  "key": "eu",
  "name": "EU sanctions",
  "category": "sanctions",
  "enabled": true,
  "recordCount": 12345,
  "updateCadence": "daily"
}

Webhook event envelope

{
  "id": "evt_1234abcd",
  "type": "screening.completed",
  "created": "2026-02-21T09:30:00.000Z",
  "version": "1",
  "data": { "auditId": "audit_123", "status": "potential_match" }
}