{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening Check", "description": "Screen customers, suppliers and counterparties against the US OFAC SDN, UN, UK and EU sanctions lists at once. Fuzzy matching catches spelling variants and aliases. Returns each hit with list, programme, score and source, and flags new designations.", "version": "0.1", "x-build-id": "fiWOvsK9WcRBCzZac" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~sanctions-screening-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-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/arched_friend~sanctions-screening-check/runs": { "post": { "operationId": "runs-sync-arched_friend-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/arched_friend~sanctions-screening-check/run-sync": { "post": { "operationId": "run-sync-arched_friend-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": { "names": { "title": "Names to screen", "type": "array", "description": "People, companies or vessels, one per line, for example a customer list or a supplier list. Write names the way they appear on documents; order and punctuation do not matter.", "items": { "type": "string" } }, "lists": { "title": "Sanctions lists", "type": "array", "description": "Which official lists to screen against. All five are downloaded fresh on every run.", "items": { "type": "string", "enum": [ "ofac_sdn", "ofac_consolidated", "un", "uk", "eu" ], "enumTitles": [ "OFAC SDN (US)", "OFAC Consolidated non-SDN (US)", "UN Security Council", "UK Sanctions List", "EU Financial Sanctions" ] }, "default": [ "ofac_sdn", "ofac_consolidated", "un", "uk", "eu" ] }, "entityType": { "title": "Party type", "enum": [ "any", "individual", "entity", "vessel", "aircraft" ], "type": "string", "description": "Only match listed parties of this type. Use Individuals for a customer list of people and Entities for companies to cut unrelated hits.", "default": "any" }, "minScore": { "title": "Minimum match score", "minimum": 50, "maximum": 100, "type": "integer", "description": "How close a name must be to count as a potential match, 50 to 100. 85 catches common spelling variants; raise it to cut noise, lower it for a stricter screen.", "default": 85 }, "maxMatchesPerName": { "title": "Matches per name", "minimum": 1, "maximum": 25, "type": "integer", "description": "The most listed parties to return for each screened name, strongest first.", "default": 5 }, "onlyMatches": { "title": "Only names with a potential match", "type": "boolean", "description": "Leave out names that screened clear.", "default": false }, "onlyChanged": { "title": "Only new and changed results", "type": "boolean", "description": "For a scheduled re-screen: return only names with a new match, a removed match or that were not screened before.", "default": false }, "requestTimeoutSecs": { "title": "Download timeout (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "How long to wait for each official list file. The EU and UK files are 25 to 50 MB.", "default": 90 }, "timeBudgetSecs": { "title": "Time budget (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "How long the run may spend screening before it returns what it has. Roughly 1,000 names fit in the default.", "default": 240 } } }, "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 } } } } } } } } } }