{ "openapi": "3.0.1", "info": { "title": "US Export Control Screening: Consolidated Screening List", "description": "Screen companies against the US government's Consolidated Screening List: BIS Entity List, Denied Persons, Unverified, Military End User, ITAR debarred and OFAC sanctions. Fuzzy name matching, one result per company.", "version": "1.0", "x-build-id": "pE2Bj8BJHzZr321Pg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/veridra~us-export-control-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-veridra-us-export-control-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/veridra~us-export-control-screening/runs": { "post": { "operationId": "runs-sync-veridra-us-export-control-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/veridra~us-export-control-screening/run-sync": { "post": { "operationId": "run-sync-veridra-us-export-control-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": { "companyNames": { "title": "Company names", "type": "array", "description": "Companies or organisations to screen, one per line, for example a customer, supplier or end user. Each gets one result. Individuals are not screened.", "items": { "type": "string" }, "default": [] }, "lists": { "title": "Lists", "type": "array", "description": "Which lists of the Consolidated Screening List to screen against. All are on by default.", "items": { "type": "string", "enum": [ "SDN", "SSI", "CMIC", "NS-MBS", "FSE", "PLC", "CAP", "EL", "DPL", "UVL", "MEU", "DTC", "ACN" ], "enumTitles": [ "SDN: Specially Designated Nationals (Treasury)", "SSI: Sectoral Sanctions Identifications (Treasury)", "CMIC: Chinese Military-Industrial Complex Companies (Treasury)", "NS-MBS: Menu-Based Sanctions (Treasury)", "FSE: Foreign Sanctions Evaders (Treasury)", "PLC: Palestinian Legislative Council (Treasury)", "CAP: Correspondent Account or Payable-Through Account Sanctions (Treasury)", "EL: Entity List (Commerce, BIS)", "DPL: Denied Persons List (Commerce, BIS)", "UVL: Unverified List (Commerce, BIS)", "MEU: Military End User List (Commerce, BIS)", "DTC: ITAR Debarred (State)", "Nonproliferation Sanctions (State)" ] }, "default": [ "SDN", "SSI", "CMIC", "NS-MBS", "FSE", "PLC", "CAP", "EL", "DPL", "UVL", "MEU", "DTC", "ACN" ] }, "matchThreshold": { "title": "Match threshold", "minimum": 70, "maximum": 100, "type": "integer", "description": "Lowest name similarity (70-100) reported as a possible match. Scores of 95 or more are reported as hits.", "default": 85 }, "maxResults": { "title": "Maximum results", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after this many results. Each result costs $0.015, so this also caps the cost of a run. Use 0 for no limit. Keep it low for a first test.", "default": 1000 }, "onlyNew": { "title": "Only new results", "type": "boolean", "description": "Monitoring mode: skip results this monitor returned in earlier runs, so a scheduled run returns, and bills, only what is new. The first run returns everything that matches.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Runs with the same name share one memory of returned results, even if you change other inputs. Leave empty to keep a separate memory for each distinct input.", "default": "" } } }, "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 } } } } } } } } } }