{ "openapi": "3.0.1", "info": { "title": "OFAC Sanctions Screener", "description": "Screen people and organizations against the official U.S. Treasury OFAC SDN and Consolidated Non-SDN sanctions lists. Uses live treasury.gov list files (with optional short-lived cache) — no third-party sanctions API, no fabricated data.", "version": "1.0", "x-build-id": "PKDXeerIHsKnnCNxC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/robin.geekydev~ofac-sanctions-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-robin.geekydev-ofac-sanctions-screener", "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/robin.geekydev~ofac-sanctions-screener/runs": { "post": { "operationId": "runs-sync-robin.geekydev-ofac-sanctions-screener", "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/robin.geekydev~ofac-sanctions-screener/run-sync": { "post": { "operationId": "run-sync-robin.geekydev-ofac-sanctions-screener", "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", "required": [ "queries" ], "properties": { "queries": { "title": "Names to screen", "type": "array", "description": "One or more person or organization names to screen against official OFAC lists.", "items": { "type": "string" } }, "searchType": { "title": "Search type filter", "enum": [ "any", "person", "organization", "vessel", "aircraft" ], "type": "string", "description": "Limit matches by OFAC sdnType. Use 'any' to search all types.", "default": "any" }, "sources": { "title": "OFAC list sources", "type": "array", "description": "Which official OFAC files to download. SDN = Specially Designated Nationals. NONSDN = Consolidated Non-SDN lists.", "items": { "type": "string", "enum": [ "SDN", "NONSDN" ] }, "default": [ "SDN", "NONSDN" ] }, "minScore": { "title": "Minimum match score (0-100)", "minimum": 50, "maximum": 100, "type": "integer", "description": "Only return matches with score >= this value.", "default": 85 }, "maxMatches": { "title": "Max matches per query", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of sanction hits to return for each name.", "default": 10 }, "address": { "title": "Address (optional)", "type": "string", "description": "Optional street address to boost address-field matches." }, "city": { "title": "City (optional)", "type": "string", "description": "Optional city to boost address-field matches." }, "stateOrProvince": { "title": "State / province (optional)", "type": "string", "description": "Optional state or province to boost address-field matches." }, "postalCode": { "title": "Postal code (optional)", "type": "string", "description": "Optional postal/ZIP code to boost address-field matches." }, "caseId": { "title": "Case ID (optional)", "type": "string", "description": "Optional ID echoed back on each result for your workflow correlation." }, "forceRefresh": { "title": "Force refresh OFAC lists", "type": "boolean", "description": "If true, always re-download official lists from treasury.gov and overwrite the named KV cache. If false, reuse cached official XML for up to cacheTtlHours.", "default": false }, "cacheTtlHours": { "title": "List cache TTL (hours)", "minimum": 0, "maximum": 168, "type": "integer", "description": "How long to reuse officially downloaded OFAC XML from the named key-value store ofac-list-cache (0–168). Cache always stores real Treasury files only — never fabricated data.", "default": 12 } } }, "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 } } } } } } } } } }