{ "openapi": "3.0.1", "info": { "title": "EU Company KYB by ID: Auto-Detect FR, NO, PL, UK, FI", "description": "Look up a SIREN, SIRET, Norwegian organisation number, Polish KRS, NIP or REGON, UK company number, or Finnish Y-tunnus. The actor detects the country, checks the checksum, and returns registry KYB data from the official open sources.", "version": "1.0", "x-build-id": "BZiuRODh0pB6QDbhs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datacraft-studio~eu-company-kyb-router/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datacraft-studio-eu-company-kyb-router", "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~eu-company-kyb-router/runs": { "post": { "operationId": "runs-sync-datacraft-studio-eu-company-kyb-router", "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~eu-company-kyb-router/run-sync": { "post": { "operationId": "run-sync-datacraft-studio-eu-company-kyb-router", "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": [ "ids" ], "properties": { "ids": { "title": "Company IDs", "minItems": 1, "maxItems": 10000, "type": "array", "description": "SIREN or SIRET, Norwegian organisation number, Polish KRS, NIP or REGON, UK company number, or Finnish Y-tunnus. Optional prefixes: FR, NO, PL, GB, UK, FI, or a VAT form such as NO 923609016 MVA, FI01120389, PL plus a NIP. Spaces and dots are ignored.", "items": { "type": "string" } }, "countryHint": { "title": "Country hint", "enum": [ "auto", "FR", "NO", "PL", "UK", "FI" ], "type": "string", "description": "Used only when a number matches more than one checksum, usually a 9-digit value that could be a French SIREN, a Norwegian organisation number, or a Polish REGON. auto leaves an unresolved clash as an ambiguous row, which is not charged.", "default": "auto" }, "mode": { "title": "Mode", "enum": [ "enrich", "monitor" ], "type": "string", "description": "Enrich returns one row per id. Monitor stores a snapshot in the named key-value store and returns a row only when the company changed. The first monitor run is a free baseline. Unchanged companies are free.", "default": "enrich" }, "includeOfficers": { "title": "Include officers", "type": "boolean", "description": "Directors and board members where the registry publishes them: France (dirigeants), Norway (roles), Poland (KRS board, masked), and the UK (officers and PSCs). Finland's open data has no board members. Charged only when at least one officer is returned.", "default": true }, "monitorKeyValueStoreName": { "title": "Monitor snapshot store", "type": "string", "description": "Named key-value store for monitor snapshots. Use the same name on later runs. Deleting it starts a new free baseline. Letters, numbers, and hyphens only.", "default": "eu-company-kyb-snapshots" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of identifiers to process in this run.", "default": 100 }, "minRequestIntervalMs": { "title": "Minimum delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between upstream calls. Keep at least 300. The Finnish open API is shared at about 300 requests per minute, and the French search API allows about 7 requests per second.", "default": 300 }, "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Optional. Overrides the COMPANIES_HOUSE_API_KEY secret for this run. Required only for UK company numbers. The key is not written to the dataset." } } }, "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 } } } } } } } } } }