# searchUnSanctions

**Identifier:** `unsanctions_searchUnSanctions`

**Provider:** [UN Sanctions](https://kirha.com/providers/unsanctions.md)

Screen a person or organisation name against the UN Security Council consolidated sanctions list (ISIL and Al-Qaida, Taliban, North Korea, Iran, Libya, Somalia and other regimes), matching every alias and original-script name. Use it for UN sanctions screening, binding on all UN member states.

## Run it with the CLI

```bash
kirha tools run unsanctions_searchUnSanctions \
  --input '{}'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "unsanctions_searchUnSanctions",
  "input": {}
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "name": {
      "description": "Name or part of a name, in any script",
      "minLength": 2,
      "type": "string"
    },
    "regime": {
      "description": "UN list, e.g., Al-Qaida, Taliban, DPRK, Iran",
      "enum": [
        "Al-Qaida",
        "Taliban",
        "DPRK",
        "Iran",
        "Iraq",
        "DRC",
        "Libya",
        "Somalia",
        "CAR",
        "Sudan",
        "Haiti",
        "Yemen",
        "GB",
        "SouthSudan"
      ],
      "type": "string"
    },
    "type": {
      "enum": [
        "individual",
        "entity"
      ],
      "type": "string"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "listGeneratedOn": {
      "type": "string"
    },
    "listed": {
      "type": "boolean"
    },
    "matches": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "birthDate": {
            "type": "string"
          },
          "listedOn": {
            "type": "string"
          },
          "matchQuality": {
            "enum": [
              "listed",
              "similar spelling",
              "partial words",
              "all words",
              "exact"
            ],
            "type": "string"
          },
          "matchedAlias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "nationalities": {
            "type": "string"
          },
          "reference": {
            "type": "string"
          },
          "regime": {
            "type": "string"
          },
          "regimeName": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "enum": [
              "individual",
              "entity"
            ],
            "type": "string"
          }
        },
        "required": [
          "reference",
          "type",
          "matchQuality",
          "regime"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "total": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "listed",
    "total",
    "matches"
  ],
  "type": "object"
}
```

## Related tools

Other UN Sanctions tools that this tool refers to, or that refer to it.

- [`getUnSanctionedParty`](https://kirha.com/providers/unsanctions/getUnSanctionedParty.md)
- [`listUnSanctionsRegimes`](https://kirha.com/providers/unsanctions/listUnSanctionsRegimes.md)

-----

[All UN Sanctions tools](https://kirha.com/providers/unsanctions.md) · [< Back to tools list](https://kirha.com/tools.md)