{ "openapi": "3.0.1", "info": { "title": "Sanctions & Company Check: OFAC, UN, EU, UK, LEI, VAT", "description": "Screen company names against OFAC, UN, EU and UK sanctions lists and US export control lists (Entity List and more), and add GLEIF LEI and EU VAT (VIES) data. One result per company, with match scores. Monitoring mode reports only changes.", "version": "1.0", "x-build-id": "9iyqe4ehn8UDdXlg1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/veridra~kyb-sanctions-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-veridra-kyb-sanctions-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/veridra~kyb-sanctions-check/runs": { "post": { "operationId": "runs-sync-veridra-kyb-sanctions-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/veridra~kyb-sanctions-check/run-sync": { "post": { "operationId": "run-sync-veridra-kyb-sanctions-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": { "companyNames": { "title": "Company names", "type": "array", "description": "Companies or organisations to check, one per line. Each gets one result. Individuals are not screened.", "items": { "type": "string" }, "default": [] }, "vatNumbers": { "title": "EU VAT numbers", "type": "array", "description": "EU VAT numbers with their country prefix, for example IE6388047V. Each is validated in VIES, and the registered name, where the country publishes it, is screened too.", "items": { "type": "string" }, "default": [] }, "lists": { "title": "Sanctions and export control lists", "type": "array", "description": "Which official lists to screen against. The US export control lists are the Commerce Department's Entity List, Denied Persons, Unverified and Military End User lists and the State Department's ITAR debarred and nonproliferation lists.", "items": { "type": "string", "enum": [ "ofac", "un", "eu", "uk", "usexport" ], "enumTitles": [ "OFAC SDN and consolidated lists (US)", "UN Security Council consolidated list", "EU consolidated financial sanctions list", "UK Sanctions List", "US export control lists (Commerce and State)" ] }, "default": [ "ofac", "un", "eu", "uk", "usexport" ] }, "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 }, "lookupLei": { "title": "Look up LEI", "type": "boolean", "description": "Find each company's Legal Entity Identifier record in GLEIF and add its status and country.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop after this many results. Each result costs $0.02, 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 } } } } } } } } } }