Zum Inhalt
HALOWERK

Handelswerk

sanctions ofac

Checks a name against the Specially Designated Nationals and Blocked Persons List published by the US Treasury Office of Foreign Assets Control. Returns each hit with the OFAC record number, the record type (individual, entity, vessel, aircraft), every sanctions programme the record is listed under, the aliases OFAC publishes together with their a.k.a./f.k.a./n.k.a.

POST https://handel.halowerk.com/v1/sanctions-ofac

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
namestringJaPerson, company, vessel or aircraft name to screen, e.g. "Ramzan Kadyrov" or "Example Trading LLC".
record_typestringNeinRestrict to one OFAC record type.
programstringNeinRestrict to an OFAC sanctions programme code, e.g. "RUSSIA-EO14024", "IRAN", "SDGT", "CUBA".
matchstringNeinexact = normalised string equality. all_words = every significant word of the query appears in the OFAC name. partial = at least one significant word, widest and noisiest.
include_weak_aliasesbooleanNeinInclude aliases OFAC itself flags as "weak". They are the main source of false positives; set false for a stricter sweep.
limitintegerNein
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 200,
      "description": "Person, company, vessel or aircraft name to screen, e.g. \"Ramzan Kadyrov\" or \"Example Trading LLC\"."
    },
    "record_type": {
      "type": "string",
      "enum": [
        "any",
        "individual",
        "entity",
        "vessel",
        "aircraft"
      ],
      "default": "any",
      "description": "Restrict to one OFAC record type."
    },
    "program": {
      "type": "string",
      "maxLength": 40,
      "description": "Restrict to an OFAC sanctions programme code, e.g. \"RUSSIA-EO14024\", \"IRAN\", \"SDGT\", \"CUBA\"."
    },
    "match": {
      "type": "string",
      "enum": [
        "exact",
        "all_words",
        "partial"
      ],
      "default": "all_words",
      "description": "exact = normalised string equality. all_words = every significant word of the query appears in the OFAC name. partial = at least one significant word, widest and noisiest."
    },
    "include_weak_aliases": {
      "type": "boolean",
      "default": true,
      "description": "Include aliases OFAC itself flags as \"weak\". They are the main source of false positives; set false for a stricter sweep."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "name": "Ramzan Kadyrov",
  "record_type": "individual",
  "program": "RUSSIA-EO14024",
  "match": "all_words",
  "include_weak_aliases": true,
  "limit": 20
}

Ergebnis & Dokumentation

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →