{ "openapi": "3.0.1", "info": { "title": "Global Sanctions Screening API - OFAC, EU, UK & UN Watchlists", "description": "[💵 $5.00 / 1K] Screen any person or company against the consolidated OFAC, EU, UK OFSI and UN sanctions lists in one call. Fuzzy name matching with scored, explained hits - or export the full normalized watchlist. Built from primary government sources, not a re-publisher.", "version": "0.1", "x-build-id": "U6dRkDVpAoiJQkCrT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdata_labs~sanctions-screening-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdata_labs-sanctions-screening-api", "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/webdata_labs~sanctions-screening-api/runs": { "post": { "operationId": "runs-sync-webdata_labs-sanctions-screening-api", "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/webdata_labs~sanctions-screening-api/run-sync": { "post": { "operationId": "run-sync-webdata_labs-sanctions-screening-api", "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": { "mode": { "title": "Mode", "enum": [ "screen", "list" ], "type": "string", "description": "screen = check your names against the lists and return scored matches (the default). list = export the full normalized consolidated watchlist.", "default": "screen" }, "names": { "title": "Names to screen", "type": "string", "description": "Person or company names to check, one per line (or a JSON array). Used in screen mode. Each name returns one result row with its scored matches across all selected lists." }, "sources": { "title": "Lists to load", "type": "array", "description": "Which sanctions lists to consolidate. Defaults to all five (OFAC SDN, OFAC consolidated, EU, UK OFSI, UN).", "items": { "type": "string", "enum": [ "OFAC_SDN", "OFAC_CONS", "EU", "UK_OFSI", "UN" ], "enumTitles": [ "US OFAC - SDN", "US OFAC - Consolidated (non-SDN)", "EU Consolidated", "UK OFSI Consolidated", "UN Security Council" ] }, "default": [ "OFAC_SDN", "OFAC_CONS", "EU", "UK_OFSI", "UN" ] }, "threshold": { "title": "Match threshold", "minimum": 50, "maximum": 100, "type": "integer", "description": "Minimum similarity (0.5-1.0) for a name to be reported as a match in screen mode. 0.85 is a balanced default; raise toward 1.0 for fewer false positives, lower for wider recall.", "default": 85 }, "maxMatchesPerName": { "title": "Max matches per name", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many top scored matches to return for each screened name (screen mode).", "default": 10 }, "maxItems": { "title": "Max watchlist rows", "minimum": 1, "maximum": 60000, "type": "integer", "description": "Safety cap on how many entities to export in list mode.", "default": 5000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. All sources are official public government files that work without a proxy; enable Apify Proxy only if you hit a network issue.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }