{
  "openapi": "3.0.1",
  "info": {
    "title": "Sanctions Screening – OFAC, UN, EU & UK Lists (Fuzzy KYC)",
    "description": "Screen people and companies against the official OFAC SDN, UN Security Council, EU and UK sanctions lists, downloaded fresh on every run. Fuzzy name matching across aliases and transliterations, date-of-birth and country checks, risk level and evidence for every hit.",
    "version": "0.1",
    "x-build-id": "3oKilPXkZwjfeHLVw"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/yck69~sanctions-screening/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-yck69-sanctions-screening",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/yck69~sanctions-screening/runs": {
      "post": {
        "operationId": "runs-sync-yck69-sanctions-screening",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/yck69~sanctions-screening/run-sync": {
      "post": {
        "operationId": "run-sync-yck69-sanctions-screening",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "names": {
            "title": "Names to screen",
            "type": "array",
            "description": "People or companies, one per line. Word order, accents and legal forms (LLC, GmbH, SA…) don't matter.",
            "items": {
              "type": "string"
            }
          },
          "entities": {
            "title": "Names with details (optional)",
            "type": "array",
            "description": "For fewer false positives, give objects with a date of birth (year is enough) and a country: <code>[{\"name\": \"Viktor Bout\", \"dateOfBirth\": \"1967\", \"country\": \"Russia\", \"type\": \"person\", \"reference\": \"client-42\"}]</code>. <code>reference</code> is copied to the output so you can join results back to your records."
          },
          "datasetId": {
            "title": "Screen a dataset (optional)",
            "type": "string",
            "description": "ID of an Apify dataset with your customer or supplier list, for example the output of another Actor."
          },
          "nameField": {
            "title": "Name field in the dataset",
            "type": "string",
            "description": "Field holding the name in each dataset item. Optional fields <code>dateOfBirth</code>, <code>country</code> and <code>reference</code> are used when present.",
            "default": "name"
          },
          "lists": {
            "title": "Sanctions lists",
            "type": "array",
            "description": "Which official lists to check. All four are downloaded fresh from the official sources on every run.",
            "items": {
              "type": "string",
              "enum": [
                "ofac",
                "un",
                "eu",
                "uk"
              ],
              "enumTitles": [
                "US OFAC SDN",
                "UN Security Council",
                "EU consolidated list",
                "UK sanctions list (FCDO)"
              ]
            },
            "default": [
              "ofac",
              "un",
              "eu",
              "uk"
            ]
          },
          "threshold": {
            "title": "Match threshold",
            "minimum": 0.7,
            "maximum": 1,
            "type": "number",
            "description": "Minimum similarity (0.70–1.00) for a potential match. 0.88 suits most KYC checks; lower it to catch more spelling variants (more false positives), raise it for exact-name checks.",
            "default": 0.88
          },
          "entityType": {
            "title": "Entity type",
            "enum": [
              "any",
              "person",
              "organization"
            ],
            "type": "string",
            "description": "Compare only with listed people, or only with organisations (companies, vessels, aircraft). Per-name <code>type</code> in the details overrides it.",
            "default": "any"
          },
          "maxMatchesPerName": {
            "title": "Max matches per name",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "Best matches returned for each name (all lists together).",
            "default": 5
          },
          "onlyMatches": {
            "title": "Output only names with a potential match",
            "type": "boolean",
            "description": "Skip the rows of clear names in the dataset. Every name is still screened and counted.",
            "default": false
          },
          "excludeDobMismatches": {
            "title": "Hide matches whose date of birth differs",
            "type": "boolean",
            "description": "When you give a date of birth, matches born more than a year apart are shown with status <code>name-match-dob-differs</code>. Turn this on to drop them.",
            "default": false
          },
          "allowPartialLists": {
            "title": "Continue if a list is unavailable",
            "type": "boolean",
            "description": "By default the run stops without charging if an official source can't be downloaded, so a screening is never silently incomplete. Turn on to screen with the lists that loaded.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}