{ "openapi": "3.0.1", "info": { "title": "Polish Company Data & KYB: KRS/NIP/REGON + VAT & Bankruptcy", "description": "Poland company data for KYB and KYC. Look up a firm by KRS, NIP or REGON: official KRS extract, Biała lista VAT white list status and IBAN check, PKD, capital, board, bankruptcy and liquidation.", "version": "1.0", "x-build-id": "hU3boRS6nluBs3phb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~polish-company-kyb/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-polish-company-kyb", "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/datacraft-studio~polish-company-kyb/runs": { "post": { "operationId": "runs-sync-datacraft-studio-polish-company-kyb", "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/datacraft-studio~polish-company-kyb/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-polish-company-kyb", "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": { "companies": { "title": "Companies", "minItems": 1, "maxItems": 3000, "type": "array", "description": "One row per company. id is a NIP, REGON (9 or 14 digits), or KRS number. Prefixes such as NIP: or KRS: are accepted. checkIbans is optional and is verified against the VAT white list for that company.", "items": { "type": "object", "properties": { "id": { "title": "NIP, REGON, or KRS", "type": "string", "description": "Digits, or with a NIP / REGON / KRS prefix. Spaces and dashes are ignored.", "editor": "textfield", "example": "7740001454" }, "type": { "title": "Identifier type", "type": "string", "description": "Auto-detect uses the NIP and REGON checksums. Force krs when a 10-digit KRS number happens to pass the NIP checksum, or when the number has no leading zero.", "enum": [ "auto", "nip", "regon", "krs" ], "enumTitles": [ "Auto-detect", "NIP", "REGON", "KRS" ], "default": "auto" }, "checkIbans": { "title": "Accounts to check", "type": "array", "description": "Polish NRB (26 digits) or PL IBAN. Each one is checked against the VAT white list for this company's NIP.", "editor": "stringList", "items": { "type": "string" } } }, "required": [ "id" ] } }, "identifierList": { "title": "Extra identifiers", "type": "string", "description": "Optional paste area. Separate NIP, REGON, or KRS values with newlines, commas, or spaces. These rows cannot carry IBAN checks; use Companies for that." }, "includeBoard": { "title": "Include board and proxies", "type": "boolean", "description": "Roles from the KRS extract. The public API masks personal names (for example D**** B****), so full names are not available. PESEL is never returned.", "default": true }, "includeInsolvencyHistory": { "title": "Include insolvency history", "type": "boolean", "description": "Also fetch the full KRS extract (OdpisPelny) so ended bankruptcy, liquidation, and restructuring entries are included. In enrich mode this adds the insolvency-history charge when the extract is retrieved.", "default": false }, "mode": { "title": "Mode", "enum": [ "enrich", "monitor" ], "type": "string", "description": "enrich returns one row per company. monitor stores a snapshot and returns only a free baseline, then later changes in status, address, name, board, PKD, VAT status, or insolvency entries.", "default": "enrich" }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that holds monitor snapshots between runs. Reuse the same name to keep the baseline.", "default": "polish-company-monitor" }, "regonApiKey": { "title": "GUS REGON (BIR1) user key", "type": "string", "description": "Optional. Your own key from GUS (regon_bir@stat.gov.pl). Used only to fill gaps, such as sole traders that are not in KRS. The key is a secret input and is not written to the dataset." }, "maxCompanies": { "title": "Maximum companies", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Fail the run instead of silently truncating when the list is longer. The VAT search quota is 100 requests per day, 30 companies each.", "default": 300 } } }, "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 } } } } } } } } } }