{ "openapi": "3.0.1", "info": { "title": "CZ & SK Company Risk Check — KYB Screening", "description": "Screen Czech and Slovak companies against four official registers in one call: ARES, the business register, the unreliable-VAT-payer list and the insolvency register (ISIR) plus Slovak RPO. Returns one clean risk JSON per company with explicit, sourced risk flags.", "version": "0.1", "x-build-id": "NJNSAHQuTjdOdnTbd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/relevate~cz-sk-company-risk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-relevate-cz-sk-company-risk", "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/relevate~cz-sk-company-risk/runs": { "post": { "operationId": "runs-sync-relevate-cz-sk-company-risk", "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/relevate~cz-sk-company-risk/run-sync": { "post": { "operationId": "run-sync-relevate-cz-sk-company-risk", "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": { "companyIds": { "title": "Company IDs (IČO)", "type": "array", "description": "Czech or Slovak 8-digit company registration numbers. This is the exact, unambiguous way to screen a company.", "default": [], "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Screen by name instead. The best register match is used — always prefer company IDs when you have them.", "default": [], "items": { "type": "string" } }, "country": { "title": "Country", "enum": [ "auto", "CZ", "SK" ], "type": "string", "description": "Czech and Slovak company IDs share the same 8-digit format. Auto tries the Czech register first, then the Slovak one. Pick a country to skip the guess.", "default": "auto" }, "includeRegisterDetail": { "title": "Include business register detail", "type": "boolean", "description": "Statutory bodies, owners, registered capital, file number, former names, and — importantly — the insolvency and liquidation entries recorded in the public business register (ARES VR / RPO).", "default": true }, "includeVatCheck": { "title": "Check VAT reliability (CZ)", "type": "boolean", "description": "Queries the Czech tax administration for the unreliable-VAT-payer flag and the officially published bank accounts. Paying an unpublished account can make you liable for your supplier's unpaid VAT.", "default": true }, "includePersons": { "title": "Include names of directors and owners", "type": "boolean", "description": "OFF by default. When on, the output includes the names of natural persons acting as directors or shareholders, as published in the public registers (home addresses are always reduced to the municipality). Enabling this makes YOU the controller of that personal data — make sure you have a lawful basis under the GDPR.", "default": false }, "maxResults": { "title": "Maximum companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on how many companies are screened in one run.", "default": 100 }, "minExpectedResults": { "title": "Health check — minimum expected results", "minimum": 0, "type": "integer", "description": "Fail the run if fewer than this many companies are screened. Use it in scheduled pipelines to get alerted when a source changes. 0 disables the check.", "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 } } } } } } } } } }