{ "openapi": "3.0.1", "info": { "title": "Sanctions Screener — OFAC, UN, EU, UK & Canada Lists", "description": "Screen names against the official OFAC SDN and consolidated, UN, EU, UK and Canada sanctions lists: fuzzy matching, birth-year and country checks, verdicts. Follow new designations, export the lists. Real-time API.", "version": "0.1", "x-build-id": "JeHIpphSBgD6xzVlo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tacps126~sanctions-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tacps126-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/tacps126~sanctions-screener/runs": { "post": { "operationId": "runs-sync-tacps126-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/tacps126~sanctions-screener/run-sync": { "post": { "operationId": "run-sync-tacps126-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": { "mode": { "title": "What to do", "enum": [ "screen", "changes", "export" ], "type": "string", "description": "Screen names, follow list changes on a schedule, or export the lists in one schema.", "default": "screen" }, "names": { "title": "Names to screen", "type": "array", "description": "People or organisations, one per line.", "items": { "type": "string" } }, "subjects": { "title": "Subjects with details (optional)", "type": "array", "description": "For fewer false positives: [{\"name\": \"…\", \"id\": \"your ref\", \"dateOfBirth\": \"1966\", \"country\": \"IR\", \"type\": \"individual\"}]. A different birth year or country lowers a match." }, "lists": { "title": "Lists", "type": "array", "description": "Empty = all seven.", "items": { "type": "string", "enum": [ "us-ofac-sdn", "us-ofac-cons", "un", "eu", "gb", "ca", "ch" ], "enumTitles": [ "US OFAC SDN List", "US OFAC Consolidated (non-SDN) List", "UN Security Council Consolidated List", "EU Consolidated Financial Sanctions List", "UK Sanctions List", "Canada Consolidated Autonomous Sanctions List", "Switzerland SECO Sanctions List" ] } }, "entityType": { "title": "Entity type", "enum": [ "any", "individual", "entity" ], "type": "string", "description": "Screen against people, organisations (with vessels and aircraft), or both.", "default": "any" }, "minScore": { "title": "Minimum score", "minimum": 50, "maximum": 100, "type": "integer", "description": "Name similarity (0–100) from which a list entry is reported as a possible match.", "default": 85 }, "matchScore": { "title": "Match score", "minimum": 50, "maximum": 100, "type": "integer", "description": "From this score the verdict is `match` (below it, `possible-match`).", "default": 95 }, "maxMatches": { "title": "Matches per name", "minimum": 1, "maximum": 50, "type": "integer", "description": "Best matching list entries reported per name.", "default": 5 }, "programs": { "title": "Programmes (changes, export)", "type": "array", "description": "Only entries whose programme or regime contains one of these words (e.g. RUSSIA, Iran, SDGT).", "items": { "type": "string" } }, "countries": { "title": "Countries (changes, export)", "type": "array", "description": "Only entries linked to these countries (names or ISO codes).", "items": { "type": "string" } }, "listedWithinDays": { "title": "Listed within the last N days (export)", "minimum": 0, "type": "integer", "description": "0 = any date.", "default": 0 }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Names screened, or entries delivered.", "default": 1000 }, "monitorName": { "title": "Monitor name (changes)", "type": "string", "description": "Keeps separate baselines for separate monitors." }, "tenantId": { "title": "Tenant id", "type": "string", "description": "For platforms serving many customers: keeps each one's monitor state apart." }, "debug": { "title": "Debug", "type": "boolean", "description": "Extra logging.", "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 } } } } } } } } } }