Zum Inhalt
HALOWERK

Handelswerk

sanctions ofsi

Checks a name against the UK Sanctions List maintained by the Foreign, Commonwealth and Development Office.

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

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
namestringJaPerson, company or ship name to screen, e.g. "Ramzan Kadyrov" or "Example Trading LLC".
designation_typestringNeinRestrict to one UK designation type.
regimestringNeinRestrict to designations whose regime name contains this text, e.g. "Russia", "Iran", "Global Human Rights".
originstringNeinRestrict by where the designation comes from. uk = UK-originated, un = mirrors a UN listing. Designations marked "UK|UN" match both.
matchstringNeinexact = normalised string equality. all_words = every significant word of the query appears in the listed name. partial = at least one significant word, widest and noisiest.
limitintegerNein
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 200,
      "description": "Person, company or ship name to screen, e.g. \"Ramzan Kadyrov\" or \"Example Trading LLC\"."
    },
    "designation_type": {
      "type": "string",
      "enum": [
        "any",
        "individual",
        "entity",
        "ship"
      ],
      "default": "any",
      "description": "Restrict to one UK designation type."
    },
    "regime": {
      "type": "string",
      "maxLength": 80,
      "description": "Restrict to designations whose regime name contains this text, e.g. \"Russia\", \"Iran\", \"Global Human Rights\"."
    },
    "origin": {
      "type": "string",
      "enum": [
        "any",
        "uk",
        "un"
      ],
      "default": "any",
      "description": "Restrict by where the designation comes from. uk = UK-originated, un = mirrors a UN listing. Designations marked \"UK|UN\" match both."
    },
    "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 listed name. partial = at least one significant word, widest and noisiest."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "name": "Ramzan Kadyrov",
  "designation_type": "individual",
  "regime": "Russia",
  "origin": "any",
  "match": "all_words",
  "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 →