{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening: Check Names Against OFAC, EU, UK & UN.", "description": "Screen any name or company against current official OFAC, EU, UK and UN sanctions & watchlists. Bulk or single, fuzzy matching with match scores, matched list and entity details. For AML/KYC compliance — for people and AI agents. Official government data, nothing stored.", "version": "0.0", "x-build-id": "TTP941DiItFI5eXTN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apifmcpfactory~sanctions-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apifmcpfactory-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/apifmcpfactory~sanctions-screening/runs": { "post": { "operationId": "runs-sync-apifmcpfactory-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/apifmcpfactory~sanctions-screening/run-sync": { "post": { "operationId": "run-sync-apifmcpfactory-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": "One or more person or company names to screen, e.g. \"AeroCaribbean Airlines\". Each name is matched against primary names and aliases on the OFAC SDN, OFAC Consolidated, EU Consolidated, UK OFSI and UN Consolidated lists, and billed once at $0.01-0.02 per name checked. Empty entries are skipped and never billed. If omitted, two demo names (one match, one clean) are used.", "default": [ "AeroCaribbean Airlines", "Acme Test Company" ], "items": { "type": "string" } }, "entityType": { "title": "Entity type", "enum": [ "any", "person", "org" ], "type": "string", "description": "Narrow matching to persons or organizations only. \"any\" (default) checks every list entry regardless of type.", "default": "any" }, "country": { "title": "Country (optional)", "type": "string", "description": "Narrow matching to list entries tagged with this country, e.g. \"Cuba\" or \"Russia\". Leave blank to match against every country." }, "threshold": { "title": "Match threshold (0-100)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Minimum fuzzy-match score (deterministic Jaro-Winkler over normalised names and aliases) for a list entry to be returned as a match. Lower catches more spelling/order variants but risks false positives; higher is stricter. Default 85.", "default": 85 }, "includeAliases": { "title": "Include aliases (a.k.a. / f.k.a.)", "type": "boolean", "description": "When true (recommended), each name is also matched against every known alias on the lists, not just the primary listed name.", "default": true }, "mode": { "title": "Mode", "enum": [ "screen", "list_status", "refresh_cache" ], "type": "string", "description": "\"screen\" (default) checks the names above. \"list_status\" returns each official list's cached record count and last-refresh date, ignoring all other fields — use it to confirm data freshness. \"refresh_cache\" force re-fetches all 5 official lists; wire this to a daily Apify Schedule rather than running it per screening call.", "default": "screen" } } }, "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 } } } } } } } } } }