{ "openapi": "3.0.1", "info": { "title": "Business Creditworthiness Check", "description": "One company per row. An open-data risk indicator from public registers, plus optional Creditsafe and Dun & Bradstreet lookups using your own API credentials. The indicator is not a credit rating. No bureau account is included. Duplicate companies in one input are checked and charged once.", "version": "0.1", "x-build-id": "5FBXx57pqeFI2dqd2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mikee368~business-creditworthiness-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mikee368-business-creditworthiness-check", "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/mikee368~business-creditworthiness-check/runs": { "post": { "operationId": "runs-sync-mikee368-business-creditworthiness-check", "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/mikee368~business-creditworthiness-check/run-sync": { "post": { "operationId": "run-sync-mikee368-business-creditworthiness-check", "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", "type": "array", "description": "Companies to check. Each item may include name, country, registrationNumber, vatNumber, duns, connectId, kvkNumber and lei. A string is treated as a name." }, "mode": { "title": "Mode", "enum": [ "indicator", "bureau", "both" ], "type": "string", "description": "indicator: open-data risk indicator only. bureau: your Creditsafe and/or D&B credentials only. both: indicator and any bureau whose credentials are set.", "default": "indicator" }, "maxCompanies": { "title": "Max companies", "minimum": 1, "maximum": 25, "type": "integer", "description": "How many companies this run checks. The default is 1 so a single-company run stays within the prepared price.", "default": 1 }, "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Your free Companies House key. Required for a UK register row and UK accounts. Never a bureau key." }, "kvkApiKey": { "title": "KvK API key", "type": "string", "description": "Your free KVK Handelsregister API key for a Dutch basis profile. Annual accounts are not in that free profile and are not requested." }, "creditsafeUsername": { "title": "Creditsafe username", "type": "string", "description": "Username for your own Creditsafe Connect contract. Leave empty to skip Creditsafe." }, "creditsafeSecret": { "title": "Creditsafe password", "type": "string", "description": "Password for your own Creditsafe Connect contract. Stored as a secret. It is not written to the dataset or the log." }, "creditsafeEnvironment": { "title": "Creditsafe environment", "enum": [ "production", "sandbox" ], "type": "string", "description": "Official Creditsafe host. production is connect.creditsafe.com. sandbox is connect.sandbox.creditsafe.com.", "default": "production" }, "dnbApiKey": { "title": "D&B consumer key", "type": "string", "description": "Consumer key for your own Dun & Bradstreet Direct+ contract. Leave empty to skip D&B." }, "dnbConsumerSecret": { "title": "D&B consumer secret", "type": "string", "description": "Consumer secret for your own Direct+ contract. Stored as a secret. It is not written to the dataset or the log." }, "dnbTokenVersion": { "title": "D&B token path", "enum": [ "v2", "v1" ], "type": "string", "description": "v2 calls POST /v2/token (Direct+ Data Blocks). v1 calls POST /v1/token (the partner authentication page). Both use plus.dnb.com.", "default": "v2" }, "dnbBlockIds": { "title": "D&B block ids", "type": "string", "description": "Comma-separated Direct+ blockIDs. Empty uses company info, financial strength, payment insight, event filings and hierarchy. principalscontacts is not in the default.", "default": "" }, "dnbOrderReason": { "title": "D&B order reason", "type": "string", "description": "Optional orderReason from your D&B contract. Empty means the parameter is not sent.", "default": "" }, "useSuppliedInsolvency": { "title": "Use supplied insolvency notices", "type": "boolean", "description": "When on, insolvencyNotices are matched to each company. The Insolvency Watch Actor is not called.", "default": false }, "insolvencyNotices": { "title": "Insolvency notices", "type": "array", "description": "Rows from the Insolvency Watch Actor (name, registrationNumber, noticeId, publishedAt, status, source). Ignored unless useSuppliedInsolvency is on.", "default": [] }, "useSuppliedSanctions": { "title": "Use supplied sanctions hits", "type": "boolean", "description": "When on, sanctionsHits are matched by company name. Sanction lists are not downloaded in this Actor.", "default": false }, "sanctionsHits": { "title": "Sanctions hits", "type": "array", "description": "Hits from sanctions-screening-watch (name or matchedName, list, uid, score). Ignored unless useSuppliedSanctions is on. An empty list is an explicit clear.", "default": [] }, "useSuppliedOwnership": { "title": "Use supplied ownership profile", "type": "boolean", "description": "When on, ownershipProfile is copied onto the row and the ownership pack is not called.", "default": false }, "ownershipProfile": { "title": "Ownership profile", "type": "object", "description": "One company-ownership-lookup shaped profile. Ignored unless useSuppliedOwnership is on.", "default": {} }, "includeOwnership": { "title": "Run ownership pack", "type": "boolean", "description": "Run the company-ownership pack in this container (GLEIF parents, and UK PSC only when includePsc is on). No child Actor is started.", "default": false }, "includePsc": { "title": "Include UK PSC names", "type": "boolean", "description": "When includeOwnership is on, also read Companies House persons with significant control. Those names are personal data. Off by default.", "default": false } } }, "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 } } } } } } } } } }