{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening: OFAC, UN, EU, UK", "description": "Screen people and companies using data from the official OFAC SDN and Consolidated, UN Security Council, EU and UK sanctions lists in one call. Fuzzy matching with transliteration, word order and aliases, a 0-100 score, the reason for each hit and the version of every list.", "version": "0.1", "x-build-id": "JTzMphcEUGZf0uNO8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/br_data_hub~global-sanctions-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-br_data_hub-global-sanctions-screening", "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/br_data_hub~global-sanctions-screening/runs": { "post": { "operationId": "runs-sync-br_data_hub-global-sanctions-screening", "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/br_data_hub~global-sanctions-screening/run-sync": { "post": { "operationId": "run-sync-br_data_hub-global-sanctions-screening", "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": "Enter people or companies to check, one per line. Any script and word order work, e.g. \"Putin Vladimir\" or \"Путин\". Use 'Names with details' to add country or year.", "default": [ "Banco Nacional de Cuba", "Vladimir Putin", "Acme Comércio Ltda" ], "items": { "type": "string" } }, "entities": { "title": "Names with details", "type": "array", "description": "Enter a JSON list of objects: {\"name\": \"...\", \"country\": \"IR\" or \"Iran\", \"year\": year of birth or incorporation, \"type\": \"person\" or \"organization\", \"reference\": your own id, copied to the output}. Country, year and type raise the score when they agree and lower it when they don't. Optional." }, "lists": { "title": "Lists", "type": "array", "description": "Pick the official lists to screen against. Keep all five for full coverage.", "items": { "type": "string", "enum": [ "ofac_sdn", "ofac_consolidated", "un", "eu", "uk" ], "enumTitles": [ "OFAC SDN (US Treasury)", "OFAC Consolidated non-SDN (US Treasury)", "UN Security Council Consolidated List", "EU Financial Sanctions Files (consolidated)", "UK Sanctions List (FCDO)" ] }, "default": [ "ofac_sdn", "ofac_consolidated", "un", "eu", "uk" ] }, "minScore": { "title": "Min score", "minimum": 50, "maximum": 100, "type": "integer", "description": "Set the lowest match score to return (50 to 100), e.g. 85. Lower finds more spelling variants and more false positives.", "default": 85 }, "maxMatchesPerName": { "title": "Max matches per name", "minimum": 1, "maximum": 100, "type": "integer", "description": "Set how many best matches to keep for each name across all lists, e.g. 10.", "default": 10 }, "entityType": { "title": "Default type", "enum": [ "any", "person", "organization" ], "type": "string", "description": "Pick the type applied to names without their own. Any does not compare types.", "default": "any" }, "cacheStoreName": { "title": "Cache store name", "type": "string", "description": "Type the key-value store where downloaded lists are kept for the day, so later runs skip the download. Leave empty to disable the cache.", "default": "sanctions-lists-cache" }, "forceRefresh": { "title": "Download lists again", "type": "boolean", "description": "Turn on to ignore today's cached copy and download every list again.", "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 } } } } } } } } } }