{ "openapi": "3.0.1", "info": { "title": "Poland Supplier Verification: VAT White List & Bank Check", "description": "Supplier verification for AP, treasury and procurement teams paying Polish suppliers: per NIP, one KYB packet with official MF VAT White List status, bank account verification (accountAssigned) with requestId audit proof, a KRZ insolvency signal and mismatch events. No API key.", "version": "0.1", "x-build-id": "lYMhwvyjoDPbxh4IQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plym-actor-factory~poland-supplier-kyb-packet/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plym-actor-factory-poland-supplier-kyb-packet", "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/plym-actor-factory~poland-supplier-kyb-packet/runs": { "post": { "operationId": "runs-sync-plym-actor-factory-poland-supplier-kyb-packet", "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/plym-actor-factory~poland-supplier-kyb-packet/run-sync": { "post": { "operationId": "run-sync-plym-actor-factory-poland-supplier-kyb-packet", "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": [ "supplierNips" ], "properties": { "supplierNips": { "title": "Supplier NIPs to verify (example NIPs prefilled — replace with yours)", "type": "array", "description": "Polish supplier tax IDs (NIP, 10 digits; punctuation optional). Optional KRS can be passed as NIP:KRS (e.g. 5261040828:0000000000). Invalid entries are skipped with no charge.", "default": [ "5261040828", "5252344078" ], "items": { "type": "string" } }, "bankAccounts": { "title": "Bank accounts (NIP:account)", "type": "array", "description": "Optional NIP:IBAN or NIP:NRB pairs for official MF accountAssigned checks (e.g. 5261040828:07101010100024791339300000). When omitted, packet still includes White List accountNumbers list but bank assignment is SKIPPED.", "default": [], "items": { "type": "string" } }, "maxRunSeconds": { "title": "Max run seconds", "minimum": 5, "maximum": 300, "type": "integer", "description": "Wall-clock budget for this batch.", "default": 55 }, "maxEvents": { "title": "Max delivered KYB packets", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many unique verified KYB packets are delivered (does not include RUN_STATUS).", "default": 500 }, "resumeFromCheckpoint": { "title": "Resume from stored checkpoint", "type": "boolean", "description": "If true, resume seen event_uids and last packet fingerprints from the default Key-Value Store.", "default": true }, "sourceMode": { "title": "Source mode (set to live for real data)", "enum": [ "fixture", "live" ], "type": "string", "description": "fixture = local/CI / Apify Store daily auto-test default (no network; emits RUN_STATUS only unless emitFixtureDemoEvents=true). live = official MF White List API (+ optional bank check) and best-effort public KRZ signal. For books above MF API daily caps, prefer official plik płaski offline (documented in README; not auto-downloaded here).", "default": "fixture" }, "emitFixtureDemoEvents": { "title": "Emit fixture demo KYB packets", "type": "boolean", "description": "When sourceMode=fixture, if true push fabricated KYB packets from local fixtures (unit/local demos only). Default false so Store daily auto-tests never emit fake packets or charge kyb-packet-delivered. Production: leave false and use sourceMode=live. SAMPLE rows only: demo events use placeholder entities (never real companies/IDs), are flagged sample=true / isSample=true, and are NEVER charged. To see them, set Source mode = fixture and put the placeholder values 9999999999, 9999999982 in \"Supplier NIPs to verify (example NIPs prefilled — replace with yours)\".", "default": false }, "includeKrz": { "title": "Include KRZ insolvency signal", "type": "boolean", "description": "If true (default), attempt public KRZ (National Debtor Register) open-proceeding flag and nest it on the packet. KRZ has no official public REST API — HTML/portal fragility may yield KRZ_CHECK_UNAVAILABLE without blocking VAT×bank verification.", "default": true }, "asOfDate": { "title": "White List as-of date (YYYY-MM-DD)", "type": "string", "description": "Optional date for MF White List / bank check queries. Default = today (UTC). Format YYYY-MM-DD." }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "minimum": 0, "type": "number", "description": "Optional soft budget hint for delivered packets. Platform ACTOR_MAX_TOTAL_CHARGE_USD also applies when set." }, "requestPaceMs": { "title": "Request pace (ms)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Minimum delay between outbound official/public HTTP requests (fair-use pacing; respect MF API daily caps).", "default": 400 } } }, "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 } } } } } } } } } }