{ "openapi": "3.0.1", "info": { "title": "CSL Restricted-Party Screening - No API Key Required", "description": "No API key required - screen names against Commerce's Consolidated Screening List (BIS, State Dept, and OFAC lists combined) for export-control and sanctions compliance.", "version": "0.1", "x-build-id": "6Wh2eTx4fJVFETddX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mooseandraven~csl-restricted-party-suite/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mooseandraven-csl-restricted-party-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~csl-restricted-party-suite/runs": { "post": { "operationId": "runs-sync-mooseandraven-csl-restricted-party-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~csl-restricted-party-suite/run-sync": { "post": { "operationId": "run-sync-mooseandraven-csl-restricted-party-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 Consolidated Screening List (substring match, diacritic-folded, tolerant of \"Last, First\" vs \"First Last\" order — a deliberately simple screen, not a fuzzy-matching compliance engine; see README). Screens both the primary name AND listed aliases. Leave empty to just fetch/monitor the full list without screening specific names — in that case this actor caps delivery at 500 records by default (a real, non-empty sample) rather than pushing all ~26,000 entries, to stay fast and cheap with zero configuration. Provide names for a real, exhaustive, uncapped screen.", "default": [], "items": { "type": "string" } }, "monitorMode": { "title": "Incremental monitor mode", "type": "boolean", "description": "When on, remembers what's already been seen (via Apify's key-value store, keyed by the CSL's own stable per-entry ID) and emits a separate `new-listing` record for anything not seen on a prior run — the daily-delta monitoring this suite is built around, since the CSL's own bulk file updates daily at 5am ET. Billing is fair, not literal: with `monitorMode` on and NO `names` (pure monitoring), you're charged the flat `monitor-run` fee plus `restricted-party-record` ONLY for genuinely new listings since your last run — never per-record for re-delivering the unchanged ~26,000-row baseline every day. The data is still fully delivered to your dataset every run; only the charging changes. If you instead provide `names` (screening a specific counterparty), normal per-match billing applies every run regardless of monitor-mode \"seen\" state.", "default": false }, "maxRecordsPerRun": { "title": "Max records delivered (quota guard)", "minimum": 0, "type": "integer", "description": "Safety cap on matched/fetched records delivered this run. Set to 0 for no cap (default for a real screen — screening should be exhaustive). The bare zero-input default path (no names, monitorMode off) is internally capped at 500 regardless of this setting, to guarantee Apify's own daily auto-test run stays fast and cheap.", "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 } } } } } } } } } }