{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening Check: OFAC, EU and UK Lists", "description": "Screen people and company names against three official sanctions lists: US Treasury OFAC (SDN), the EU consolidated list and the UK Sanctions List. Screen a supplier list, or check a person with a date of birth. Aliases and scored reasons, to Google Sheets. A screening aid, not a compliance verdict.", "version": "1.0", "x-build-id": "G8chAyp12aL2UDACc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~sanctions-screening-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-sanctions-screening-check", "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/accountable_eel~sanctions-screening-check/runs": { "post": { "operationId": "runs-sync-accountable_eel-sanctions-screening-check", "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/accountable_eel~sanctions-screening-check/run-sync": { "post": { "operationId": "run-sync-accountable_eel-sanctions-screening-check", "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": { "entities": { "title": "Names to screen", "type": "array", "description": "One name per line — a person or an organisation, exactly as you hold it (registered company name, full legal name). Up to 1,000 per run. Every name is compared against the primary names AND the aliases on each list you select. Accepted formats: Rosneft Oil Company, Aiman Muhammed Rabi Al-Zawahiri, Gazprombank Joint Stock Company. You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Stop after this many results", "minimum": 1, "type": "integer", "description": "Optional. Stop the run once this many results have been found — useful for a quick, cheap sample. Leave blank for no limit." }, "entityType": { "title": "What kind of name is this?", "enum": [ "any", "individual", "organisation" ], "type": "string", "description": "Narrows which list entries can match, and which normalisation runs: legal forms (Ltd, LLC, OOO, GmbH) are stripped from organisation names, honorifics (Dr, Shaykh, General) from people's names.", "default": "any" }, "lists": { "title": "Lists to screen against", "enum": [ "all", "ofac", "eu", "uk" ], "type": "string", "description": "Each list is downloaded from the issuing authority's own published export. You are charged once per name screened, whichever lists you pick.", "default": "all" }, "minScore": { "title": "Minimum match score (0-100)", "type": "integer", "description": "Candidates scoring below this are not reported. 85 is a deliberately cautious default. A candidate whose NAME alone scored 95 or more is always reported even if a date-of-birth or country conflict pushed its final score under your threshold.", "default": 85 }, "maxMatchesPerEntity": { "title": "Max matches per entity", "type": "integer", "description": "How many candidate matches to show per name, highest score first. The full count is always reported in \"Candidate matches found\". Up to 50.", "default": 5 }, "country": { "title": "Country (optional, ISO-2)", "type": "string", "description": "Optional. A 2-letter country code (GB, RU, DE) for the entity you are screening. A list entry whose published nationality agrees scores slightly higher; one that contradicts it scores 10 lower, and says so. Entries that publish no nationality are never penalised.", "default": "" }, "dateOfBirth": { "title": "Date of birth (optional, people only)", "type": "string", "description": "Optional. YYYY or YYYY-MM-DD. A list entry whose published date of birth agrees scores slightly higher; one that contradicts it scores 15 lower, and says so. It never deletes a candidate that matched the name exactly.", "default": "" }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "input", "screeningStatus", "matchCount", "bestScore", "matches", "notes", "disclaimer", "screenedAt", "listsChecked", "entityCount", "screenedCount", "possibleMatchCount", "results" ], "enumTitles": [ "Name screened", "Result", "Candidate matches found", "Best score", "Candidate matches", "Notes", "Disclaimer", "Screened at", "Lists checked", "Names in this run", "Names fully screened", "Names with a possible match", "All results (full list)" ] }, "default": [ "input", "screeningStatus", "matchCount", "bestScore", "matches", "notes", "disclaimer", "screenedAt", "listsChecked", "entityCount", "screenedCount", "possibleMatchCount", "results" ] }, "expandRows": { "title": "One row per entity (recommended) — turn off for one row per screening run instead", "type": "boolean", "description": "When on, each entity found gets its own row instead of being grouped under its screening run. You're still only charged once per screening run, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 1, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy config. Residential recommended for anti-bot-sensitive targets.", "default": { "useApifyProxy": 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 } } } } } } } } } }