{ "openapi": "3.0.1", "info": { "title": "UK Business Trust Check: Verify Any UK Company or Trader", "description": "Verify any UK company or trader before you pay. Returns a verdict (looks_legitimate, caution, high_risk, cannot_verify), 0-100 score and cited reasons from Companies House, The Gazette, UK Sanctions List and FSA. Input: name, website or company number; list, CSV or Sheet. Per business. x402, MCP.", "version": "0.1", "x-build-id": "a5L7P9j7P85zhUYrm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nerolabs~uk-business-trust-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nerolabs-uk-business-trust-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/nerolabs~uk-business-trust-check/runs": { "post": { "operationId": "runs-sync-nerolabs-uk-business-trust-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/nerolabs~uk-business-trust-check/run-sync": { "post": { "operationId": "run-sync-nerolabs-uk-business-trust-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": { "businesses": { "title": "Businesses (list)", "type": "array", "description": "A JSON list of businesses, each with any of businessName, website, companyNumber, postcode, town, phone. Any other keys are kept and returned untouched. Example: [{\"businessName\": \"Acme Electrical Ltd\", \"website\": \"acme-electrical.co.uk\", \"postcode\": \"LE11 2HP\"}]." }, "datasetId": { "title": "Dataset", "type": "string", "description": "Check every row of an existing Apify dataset, for example a Google Maps or directory scrape. Every original column comes back with the trust verdict added. Use this OR 'File URL' OR 'Businesses'." }, "fileUrl": { "title": "File URL (CSV, Excel, JSON or Google Sheet)", "type": "string", "description": "A public link to a CSV, Excel .xlsx, JSON or JSON Lines file, or a Google Sheet shared as 'Anyone with the link can view'. Every original column is kept." }, "fileFormat": { "title": "File format", "enum": [ "auto", "csv", "tsv", "json", "jsonl", "xlsx" ], "type": "string", "description": "Only needed if automatic detection gets the file format wrong.", "default": "auto" }, "fieldMapping": { "title": "Field mapping (column names)", "type": "object", "description": "Only needed when your columns have unusual names. Map businessName, website, companyNumber, postcode, town and phone to your column names, e.g. {\"businessName\": \"title\", \"website\": \"url\"}. Left empty, common names are detected automatically (title, name, company, website, url, domain, postcode, postalCode, city, company_number). A postcode inside an 'address' column is picked up too." }, "businessName": { "title": "Business name", "type": "string", "description": "Trading or registered name, for a single check." }, "website": { "title": "Website", "type": "string", "description": "The business's website, for a single check. The site is read for its company number, legal name, VAT number and trade badges." }, "companyNumber": { "title": "Company number", "type": "string", "description": "Companies House number, if you have it (e.g. 00445790 or SC759398)." }, "postcode": { "title": "Postcode", "type": "string", "description": "Where the business trades. Helps pick the right company when names are similar." }, "includeOfficers": { "title": "Check directors", "type": "boolean", "description": "Cross-check up to four active directors: other appointments at insolvent companies, name matches on the disqualified directors register, and the UK Sanctions List. Company register data only. Turn off for a faster, lighter check.", "default": true }, "includeGazette": { "title": "Check The Gazette", "type": "boolean", "description": "Search The Gazette for corporate insolvency notices (winding-up petitions, liquidations). The Gazette rate-limits heavy use; if it refuses, rows say so rather than claiming there are none.", "default": true }, "checkFoodHygiene": { "title": "Always check food hygiene rating", "type": "boolean", "description": "Food businesses (by name, website title or SIC code) are checked against the Food Standards Agency ratings automatically. Turn this on to check every business.", "default": false }, "maxPagesPerSite": { "title": "Pages to read per website", "minimum": 1, "maximum": 8, "type": "integer", "description": "The homepage plus the privacy, terms, contact and about pages, where UK firms publish their company number and legal name.", "default": 4 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "ON by default. A site that asks automated readers to stay away is not read; the check carries on from the name.", "default": true }, "concurrency": { "title": "Businesses at a time", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many businesses are checked in parallel. The Companies House rate limit (600 calls per five minutes) is the real ceiling, so more than 3 rarely helps.", "default": 3 }, "maxItems": { "title": "Maximum businesses", "minimum": 1, "type": "integer", "description": "Check at most this many rows from the input. Leave empty for all (up to 10,000 per run)." } } }, "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 } } } } } } } } } }