{ "openapi": "3.0.1", "info": { "title": "OFAC Sanctions Screening API — No API Key Required", "description": "No API key required — screen names against the official U.S. Treasury OFAC SDN and Consolidated sanctions lists for AML/KYB compliance. Keyless, no scraping.", "version": "0.1", "x-build-id": "5k70G4d15K3VcgGNX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mooseandraven~ofac-sanctions-screening-suite/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mooseandraven-ofac-sanctions-screening-suite", "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/mooseandraven~ofac-sanctions-screening-suite/runs": { "post": { "operationId": "runs-sync-mooseandraven-ofac-sanctions-screening-suite", "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/mooseandraven~ofac-sanctions-screening-suite/run-sync": { "post": { "operationId": "run-sync-mooseandraven-ofac-sanctions-screening-suite", "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": "Individual or entity names to screen against the sanctions lists (case-insensitive substring match against the official SDN_Name field). Leave empty to fetch the full list instead (subject to maxRecordsPerRun).", "default": [], "items": { "type": "string" } }, "lists": { "title": "Lists to screen against", "type": "array", "description": "Which official Treasury lists to check. SDN = Specially Designated Nationals (primary sanctions list). CONSOLIDATED = the non-SDN consolidated sanctions list (e.g. Foreign Sanctions Evaders, Sectoral Sanctions Identifications). Any REAL screen (names provided) always defaults to BOTH lists regardless of this field's own default — SDN coverage is never silently dropped from an actual screen. Only a run with no names to screen at all uses a cheaper single-list default; that run always discloses exactly which list(s) were and weren't included via a lists-coverage output record.", "items": { "type": "string", "enum": [ "SDN", "CONSOLIDATED" ] }, "default": [ "SDN", "CONSOLIDATED" ] }, "programFilter": { "title": "Sanctions program filter", "type": "array", "description": "Optional: restrict results to specific sanctions programs (e.g. \"CUBA\", \"IRAN\", \"DPRK3\"). Leave empty for no filter. Program codes are as published by OFAC; check a full-list run's output for the exact codes in use if unsure.", "default": [], "items": { "type": "string" } }, "monitorMode": { "title": "Incremental monitor mode", "type": "boolean", "description": "When on, the actor remembers which entity numbers (ent_num) it has seen before (via Apify key-value store) and emits an additional 'new-listing' record for anything that's newly appeared on the list since the last run. Designed for scheduled runs watching for new sanctions designations. Charges one monitor-run PPE event in addition to per-record events.", "default": false }, "maxRecordsPerRun": { "title": "Max records per list (optional cap — screening is exhaustive by default)", "minimum": 0, "type": "integer", "description": "Applied INDEPENDENTLY to each list in `lists` (not shared across them). Default 0 = no cap — every matching record on every requested list is returned, because a sanctions screen must be exhaustive by default; a silently-partial screen is the worst failure mode for this actor. If you set a cap and it truncates a list, the actor emits a loud `screening-status` TRUNCATED record and a warning log — it never reports a capped run as a complete screen. The full SDN + Consolidated lists together are roughly 17,000-20,000 entries. IMPORTANT: if you request a full-list export with no `names` (e.g. explicitly setting `lists: [\"SDN\"]` with nothing to screen) and leave this at 0, fetching and pushing the entire ~19,000-row SDN list can exceed Apify's own per-run cost limit and abort partway through — set an explicit cap for full-list exports.", "default": 0 } } }, "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 } } } } } } } } } }