{ "openapi": "3.0.1", "info": { "title": "Sanctions & Watchlist Screener (OFAC, EU, UK, UN)", "description": "Fuzzy-screen people and company names against OFAC SDN + Consolidated, EU, UK and UN sanctions lists from the official sources (re-downloaded at least every 6 h; each row shows list publication dates). Match scores, aliases, programs, country and DOB filters. Not a certified screening service.", "version": "0.1", "x-build-id": "9rY9yUtga2Am9ugau" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fairquery~sanctions-watchlist-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fairquery-sanctions-watchlist-screener", "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/fairquery~sanctions-watchlist-screener/runs": { "post": { "operationId": "runs-sync-fairquery-sanctions-watchlist-screener", "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/fairquery~sanctions-watchlist-screener/run-sync": { "post": { "operationId": "run-sync-fairquery-sanctions-watchlist-screener", "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", "type": "array", "description": "People or organisations to screen, one per line.", "items": { "type": "string" } }, "queries": { "title": "Detailed queries", "type": "array", "description": "Optional: [{\"name\": \"Ali Khamenei\", \"id\": \"cust-42\", \"country\": \"IR\", \"dateOfBirth\": \"1939-04-19\", \"entityType\": \"individual\"}]. country = ISO-2 or name; dateOfBirth = YYYY or YYYY-MM-DD.", "default": [] }, "lists": { "title": "Lists", "type": "array", "description": "Which official lists to screen against. Default: all five.", "items": { "type": "string", "enum": [ "OFAC_SDN", "OFAC_CONS", "EU", "UK", "UN" ], "enumTitles": [ "OFAC SDN (US)", "OFAC Consolidated non-SDN (US)", "EU Consolidated Financial Sanctions", "UK Sanctions List (FCDO/OFSI)", "UN Security Council Consolidated" ] }, "default": [ "OFAC_SDN", "OFAC_CONS", "EU", "UK", "UN" ] }, "minScore": { "title": "Minimum match score (0-100)", "minimum": 60, "maximum": 100, "type": "integer", "description": "Fuzzy name score threshold. 85 balances recall and noise; use 90+ for fewer false positives, 80 for more recall.", "default": 85 }, "maxMatchesPerName": { "title": "Max matches per name", "minimum": 1, "maximum": 100, "type": "integer", "description": "Top matches returned per name (match_count still reports the total).", "default": 10 }, "entityType": { "title": "Entity type", "enum": [ "any", "individual", "entity" ], "type": "string", "description": "Default for all names; a query's own entityType wins.", "default": "any" }, "country": { "title": "Country (default for all names)", "type": "string", "description": "ISO-2 code or country name. Adds country_match to each match; see excludeNonMatchingCountry." }, "excludeNonMatchingCountry": { "title": "Drop matches with a different country", "type": "boolean", "description": "If on, matches whose listed countries do not include the query country are removed (entries without country data are kept).", "default": false }, "dobYearTolerance": { "title": "Date-of-birth year tolerance", "minimum": 0, "maximum": 10, "type": "integer", "description": "When a query has dateOfBirth, listed individuals whose birth years differ by more than this are dropped (entries without DOB are kept).", "default": 1 }, "listDownloadTimeoutSecs": { "title": "List download timeout (s)", "minimum": 20, "maximum": 600, "type": "integer", "description": "Per list file. A list that cannot be downloaded is reported in lists_unavailable; the others are still screened.", "default": 60 }, "listCacheMaxAgeHours": { "title": "List cache freshness window (hours)", "minimum": 0, "maximum": 12, "type": "integer", "description": "Reuse lists downloaded by an earlier run of this Actor in your account (named key-value store 'fairquery-sanctions-list-cache') if they were downloaded from the official source less than this many hours ago. Older cached lists are never used; they are downloaded again. 0 = always download fresh. Every result row reports each list's publication date, download time and cache age in list_versions.", "default": 6 }, "maxNames": { "title": "Max names", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Safety cap per run.", "default": 10000 } } }, "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 } } } } } } } } } }