{ "openapi": "3.0.1", "info": { "title": "Sanctions Screener: OFAC, UN, EU & UK Lists", "description": "Screen people and companies against the official OFAC SDN and Consolidated, UN, EU and UK sanctions lists, refreshed from official sources every 6h. Fuzzy matching handles aliases and spelling variants. Returns list, program, country, DOB. From $1.50/1k.", "version": "0.1", "x-build-id": "14oeokt6DcRc0ShhH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/swillz~sanctions-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-swillz-sanctions-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/swillz~sanctions-screener/runs": { "post": { "operationId": "runs-sync-swillz-sanctions-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/swillz~sanctions-screener/run-sync": { "post": { "operationId": "run-sync-swillz-sanctions-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 to screen", "type": "array", "description": "Required unless datasetId is set. People or company names, e.g. [\"Rosneft\",\"Acme Trading LLC\"]. Add \" | Country\" to flag country matches, e.g. \"Vladimir Putin | RU\". Objects work too: {\"name\":\"...\",\"country\":\"IR\",\"type\":\"entity\"}.", "items": { "type": "string" } }, "lists": { "title": "Lists", "type": "array", "description": "Which official lists to check (default: all). Each is downloaded fresh from the government source on every run.", "items": { "type": "string", "enum": [ "ofac_sdn", "ofac_consolidated", "un", "eu", "uk" ], "enumTitles": [ "OFAC SDN (US)", "OFAC Consolidated non-SDN (US)", "UN Security Council", "EU Consolidated", "UK Sanctions List" ] }, "default": [ "ofac_sdn", "ofac_consolidated", "un", "eu", "uk" ] }, "minScore": { "title": "Minimum match score", "minimum": 70, "maximum": 100, "type": "integer", "description": "0-100 similarity needed to report a match (default 85). 92+ gives fewer, closer matches; 80 catches more spelling variants. Range 70-100.", "default": 85 }, "entityType": { "title": "Entity type", "enum": [ "any", "individual", "entity" ], "type": "string", "description": "Only match listed individuals, only entities (companies, vessels, aircraft), or any (default).", "default": "any" }, "maxMatchesPerName": { "title": "Max matches per name", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many listed records to return per name, best first (default 5, max 25). matchCount always shows the total.", "default": 5 }, "defaultCountry": { "title": "Default country", "type": "string", "description": "Optional country (2-letter code or name) used as the hint for names without \" | Country\". It only sets countryMatch; it never hides matches.", "default": "" }, "maxNames": { "title": "Max names", "minimum": 1, "type": "integer", "description": "Screen at most this many unique names per run (default 10000). Aliases: maxItems, limit.", "default": 10000 }, "datasetId": { "title": "Or: dataset ID from another Actor", "type": "string", "description": "Optional. Read names from another run's dataset, e.g. a supplier or customer export. In an integration the triggering run's dataset is used automatically." }, "nameField": { "title": "Name field in the dataset", "type": "string", "description": "Field with the name. Auto-detected from name, fullName, companyName, company, legalName, title and more. Dot paths work, e.g. \"owner.name\"." }, "countryField": { "title": "Country field in the dataset", "type": "string", "description": "Optional field with a country (code or name). Auto-detected from country, countryCode, nationality, location." }, "datasetMaxItems": { "title": "Max dataset items", "minimum": 1, "type": "integer", "description": "Read at most this many items from datasetId (default 1000).", "default": 1000 }, "alwaysDownloadFresh": { "title": "Always download fresh lists", "type": "boolean", "description": "Off (default): use the copy of each list downloaded from the official source within the last maxListAgeHours (refreshed every 6 hours), which makes runs fast. On: download every list from the government sites in this run (adds 1-2 minutes).", "default": false }, "maxListAgeHours": { "title": "Max list age (hours)", "minimum": 1, "maximum": 168, "type": "integer", "description": "Use the cached copy of a list only if it was downloaded from the official source within this many hours (default 24, min 1). Older lists are downloaded live.", "default": 24 }, "downloadTimeoutSecs": { "title": "List download timeout (seconds)", "minimum": 30, "maximum": 300, "type": "integer", "description": "Per-file timeout for downloading a list (default 150). A list that cannot be downloaded is reported in listsNotChecked and its rows are not charged.", "default": 150 } } }, "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 } } } } } } } } } }