{ "openapi": "3.0.1", "info": { "title": "UN & UK OFSI Sanctions Screening Scraper (AML / KYB Watchlist)", "description": "Browse or screen names against the UN Security Council and UK OFSI (HM Treasury) consolidated sanctions lists. Persons, entities and vessels with aliases, DOB, nationalities, IDs, regime and listing dates. LIST and SCREEN (fuzzy name match) modes for AML/KYB.", "version": "0.1", "x-build-id": "uIK5gn21YUeDaQLg0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~un-uk-sanctions-screening-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-un-uk-sanctions-screening-scraper", "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/scrapers_lat~un-uk-sanctions-screening-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-un-uk-sanctions-screening-scraper", "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/scrapers_lat~un-uk-sanctions-screening-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-un-uk-sanctions-screening-scraper", "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": [ "list", "screen" ], "type": "string", "description": "list = browse/filter the consolidated sanctions lists. screen = check your own names against the lists (fuzzy AML/KYB screening).", "default": "list" }, "names": { "title": "Names to screen (screen mode)", "type": "array", "description": "Screen mode only. Person or company names to check against the combined UN + UK OFSI lists. One matched/not-matched row is returned per name.", "items": { "type": "string" } }, "minScore": { "title": "Match threshold (screen mode)", "minimum": 0.3, "maximum": 1, "type": "number", "description": "Screen mode only. Minimum similarity (0-1) for a fuzzy name match. Lower catches more (looser), higher is stricter. Default 0.85.", "default": 0.85 }, "source": { "title": "Source list", "enum": [ "both", "UN", "UK-OFSI" ], "type": "string", "description": "Which official list to use. UN = UN Security Council Consolidated List. UK-OFSI = UK HM Treasury (OFSI) Consolidated List. both = combined.", "default": "both" }, "entityType": { "title": "Entity type (list mode)", "enum": [ "all", "Individual", "Entity", "Vessel" ], "type": "string", "description": "List mode filter. Return only individuals, only entities (companies/groups), only vessels, or all.", "default": "all" }, "nameContains": { "title": "Name contains (list mode)", "type": "string", "description": "List mode filter. Keep only records whose primary name or any alias contains this text." }, "country": { "title": "Country / nationality contains (list mode)", "type": "string", "description": "List mode filter. Keep only records whose nationality, country of birth or address country contains this text (for example Russia, Iran, DPRK)." }, "regime": { "title": "Regime / list type contains (list mode)", "type": "string", "description": "List mode filter. Keep only records whose sanctions regime or UN list type contains this text (for example Russia, DRC, ISIL, Cyber)." }, "maxEntries": { "title": "Max records", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "List mode: maximum sanctioned records to return. Free Apify plans are capped at 10 per run." }, "withAiRisk": { "title": "AI compliance risk note (paid add-on)", "type": "boolean", "description": "Optional paid AI add-on, off by default. For each matched/returned sanctioned party, adds a plain-English risk note (who, why listed, regime, risk level). Billed only when produced. Requires a paid Apify plan.", "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 } } }, "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 } } } } } } } } } }