{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening: OFAC, EU, UN & UK Lists", "description": "Screen up to 10,000 names against the official OFAC (SDN + Consolidated), EU, UN Security Council and UK sanctions lists. Fuzzy matching with aliases, transliteration, country and date-of-birth checks. A screening aid, not a compliance decision.", "version": "1.1", "x-build-id": "lS5HfT8KzxfTecApG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offerastudio~sanctions-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offerastudio-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/offerastudio~sanctions-screening/runs": { "post": { "operationId": "runs-sync-offerastudio-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/offerastudio~sanctions-screening/run-sync": { "post": { "operationId": "run-sync-offerastudio-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", "maxItems": 10000, "type": "array", "description": "Up to 10,000 names. Each entry is either a plain text name or an object: {\"name\": \"...\", \"type\": \"person\" | \"entity\", \"country\": \"RU\" or \"Russia\", \"dateOfBirth\": \"1952-10-07\", \"reference\": \"your own ID\"}. Only name is required. Type, country and date of birth are optional and only adjust the score (a matching country or date of birth raises it, a conflicting one lowers it). Dates are YYYY-MM-DD, YYYY-MM or YYYY. The Actor does not keep your names after the run." }, "lists": { "title": "Lists", "type": "array", "description": "Which lists to screen against. The EU list is back in the defaults: its official file download needs an EU Login session, so \"EU consolidated list\" is read from the European Commission's EU Sanctions Map (sanctionsmap.eu), and the file is tried first. \"EU FSF file only\" is the file download alone and is usually unavailable; do not select both.", "items": { "type": "string", "enum": [ "ofac-sdn", "ofac-consolidated", "eu-sanctions-map", "eu-fsf", "un-consolidated", "uk-sanctions" ], "enumTitles": [ "OFAC SDN list (US)", "OFAC Consolidated non-SDN list (US)", "EU consolidated list (EU Sanctions Map, official)", "EU FSF file only (needs EU Login, usually unavailable)", "UN Security Council consolidated list", "UK sanctions list" ] }, "default": [ "ofac-sdn", "ofac-consolidated", "eu-sanctions-map", "un-consolidated", "uk-sanctions" ] }, "threshold": { "title": "Match threshold (0-100)", "minimum": 0, "maximum": 100, "type": "integer", "description": "A name is a possible match when an entry scores at least this much. Lower finds more (and more false alarms), higher finds fewer (and risks missing spelling variants). 85 is a common starting point.", "default": 85 }, "includeAliases": { "title": "Compare with aliases", "type": "boolean", "description": "Also compare with the aliases (a.k.a., f.k.a.) of each entry, not only the main name. Strongly recommended.", "default": true } } }, "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 } } } } } } } } } }