{ "openapi": "3.0.1", "info": { "title": "Supplier Risk Report: Sanctions, VAT & Insolvency", "description": "Upload your supplier list and get one risk row per supplier from official registers: EU VAT (VIES), LEI and parent, sanctions lists, UK insolvency and Companies House, US OSHA/EPA, FDA warning letters and recalls. Risk score 0-100 and what changed since last run.", "version": "1.0", "x-build-id": "ru3yymscsZ4kFMAyq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offerastudio~supplier-risk-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offerastudio-supplier-risk-report", "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/offerastudio~supplier-risk-report/runs": { "post": { "operationId": "runs-sync-offerastudio-supplier-risk-report", "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/offerastudio~supplier-risk-report/run-sync": { "post": { "operationId": "run-sync-offerastudio-supplier-risk-report", "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": [ "suppliers" ], "properties": { "suppliers": { "title": "Suppliers", "type": "array", "description": "A list of suppliers: [{\"name\": \"Siemens AG\", \"country\": \"DE\", \"vat\": \"DE129274202\", \"lei\": \"W38RGI023J3WT1HWRP32\", \"companyNumber\": \"\", \"domain\": \"siemens.com\"}]. Only \"name\" is required; \"country\" (two letters) decides which checks run; a VAT number, LEI or UK company number sharpens the match. Up to 1,000." }, "checks": { "title": "Checks", "type": "array", "description": "Which checks to run. Default: all that apply to each supplier.", "items": { "type": "string", "enum": [ "vat", "lei", "sanctions", "uk-insolvency", "uk-company", "us-osha-epa", "fda-warning-letters", "us-recalls" ], "enumTitles": [ "EU VAT number (VIES)", "Legal entity and parent (GLEIF LEI)", "Sanctions lists (OFAC, EU, UN, UK)", "UK insolvency notices (The Gazette)", "UK company status and officers (Companies House, key needed)", "US OSHA and EPA enforcement (EPA free; OSHA needs a free DOL key)", "FDA warning letters", "US product recalls (FDA, CPSC)" ] }, "default": [ "vat", "lei", "sanctions", "uk-insolvency", "uk-company", "us-osha-epa", "fda-warning-letters", "us-recalls" ] }, "mode": { "title": "Mode", "enum": [ "all", "monitor" ], "type": "string", "description": "All: one row per supplier every run, with the changes since the last run. Monitor: only suppliers whose result changed (and every supplier on the first run).", "default": "all" }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Names this supplier list. Runs with the same name share a memory of the last result per supplier (a named key-value store), which is how \"changes since last run\" works. Default: derived from the list." }, "companiesHouseApiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Free key from developer.company-information.service.gov.uk. Turns on the UK company status and officer-change check. Without it that check is skipped with a note. Stored encrypted." }, "dolApiKey": { "title": "US Department of Labor API key (optional)", "type": "string", "description": "Free key from dataportal.dol.gov. Turns on OSHA inspections (EPA works without a key). Stored encrypted." } } }, "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 } } } } } } } } } }