{ "openapi": "3.0.1", "info": { "title": "Company Credit Data API - Credit Scores, Financials, Directors", "description": "Search official company registers in over 100 countries and pull credit scores, credit limits, turnover, shareholders, directors and filed accounts as flat rows. Includes confidence matching to clean a messy company list, and director search. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "fQJHeb0ECrDYMSEig" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~company-credit-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-credit-data-api", "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/nabeelbaghoor~company-credit-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-company-credit-data-api", "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/nabeelbaghoor~company-credit-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-company-credit-data-api", "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": { "mode": { "title": "Mode", "enum": [ "company-search", "credit-report", "confidence-match", "director-search" ], "type": "string", "description": "What this run does. Company search finds companies in the register and returns their identity, status and address. Credit report orders the full report for identifiers you already hold. Confidence match scores a name and address pair against the register and tells you how sure the match is. Director search finds officers by name.", "default": "company-search" }, "countries": { "title": "Countries", "type": "array", "description": "Two letter ISO country codes to search, for example GB, US, DE. Required for every mode except credit reports. This API has no global index, so the country decides which register is queried and which search criteria are available. Confidence match uses the first country only.", "items": { "type": "string" } }, "companyName": { "title": "Company name", "type": "string", "description": "The company name to look for. Partial names match unless exact matching is switched on." }, "exactName": { "title": "Exact name match", "type": "boolean", "description": "Require the name to match exactly rather than partially. Availability varies by country.", "default": false }, "tradeName": { "title": "Trade name", "type": "string", "description": "The trading name, used in countries where the registered name is not unique." }, "acronym": { "title": "Acronym", "type": "string", "description": "A commonly known short name for the company, for companies better known by an acronym than by their full registered name." }, "regNo": { "title": "Registration number", "type": "string", "description": "The local company identifier from the domestic filing agency, for example a UK company number or a French SIREN or SIRET." }, "vatNo": { "title": "VAT number", "type": "string", "description": "The company VAT number." }, "safeNo": { "title": "Safe number", "type": "string", "description": "The provider's own company identifier in its home countries." }, "connectId": { "title": "Company id", "type": "string", "description": "The provider's primary cross-border company identifier. Search by it when you already hold one." }, "website": { "title": "Website", "type": "string", "description": "The company website. Availability varies by country." }, "status": { "title": "Company status", "enum": [ "Active", "NonActive", "Pending", "Other" ], "type": "string", "description": "Restrict to companies with this registration status." }, "companyType": { "title": "Company type", "enum": [ "NotSet", "Ltd", "NonLtd", "NonLtdNonReg" ], "type": "string", "description": "Limited, non-limited, or non-limited and unregistered. The last is only available in Norway." }, "officeType": { "title": "Office type", "enum": [ "registered", "trading", "headOffice", "branch", "subsidiary", "franchise", "franchisor", "singleOffice", "other" ], "type": "string", "description": "Restrict to a kind of site, for example only head offices or only branches." }, "address": { "title": "Address", "type": "string", "description": "A free-text address to match against, when you do not have it split into parts." }, "street": { "title": "Street", "type": "string", "description": "Street name." }, "houseNo": { "title": "House number", "type": "string", "description": "House or building number." }, "city": { "title": "City", "type": "string", "description": "City or town." }, "postCode": { "title": "Postcode", "type": "string", "description": "Postcode or ZIP code. A partial code with a trailing asterisk widens the search to a region, for example SW1*." }, "province": { "title": "Province", "type": "string", "description": "Province or state." }, "state": { "title": "State", "type": "string", "description": "State, used by the confidence match in countries that split state from province." }, "phoneNo": { "title": "Phone number", "type": "string", "description": "Company phone number." }, "matchNames": { "title": "Names to match", "type": "array", "description": "One company name per line. Each is scored against the register in turn and every candidate above the threshold is stored with its confidence score. Confidence match mode only.", "items": { "type": "string" } }, "matchThreshold": { "title": "Match threshold", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The minimum confidence score a candidate must reach. The provider documents 898 as a good match on name alone, and higher bands as stricter. Defaults to 898." }, "connectIds": { "title": "Company ids for reports", "type": "array", "description": "The company identifiers to order full credit reports for. These are the connectId values that the company search returns. Credit report mode only.", "items": { "type": "string" } }, "fetchCreditReport": { "title": "Order a report for every search hit", "type": "boolean", "description": "In company search mode, order the full credit report for each company found instead of returning the short search record. This is one extra provider call per company and is billed on your own plan accordingly.", "default": false }, "reportLanguage": { "title": "Report language", "type": "string", "description": "Two letter language code for report field content, for example EN. The report structure itself is the same in every language." }, "reportTemplate": { "title": "Report template", "type": "string", "description": "An optional report template name that adds or removes report sections. Templates are specific to your own account." }, "includeIndicators": { "title": "Include indicator scores", "type": "boolean", "description": "Add the provider's indicator scores, such as financial strength and payment behaviour, to the report.", "default": false }, "reportCustomData": { "title": "Report custom data", "type": "string", "description": "Extra report parameters some countries require, in the provider's key::value form, for example de_reason_code::1 for German reports." }, "firstName": { "title": "Director first name", "type": "string", "description": "The director's first name. Director search mode only." }, "lastName": { "title": "Director last name", "type": "string", "description": "The director's last name." }, "dateOfBirth": { "title": "Date of birth", "type": "string", "description": "The director's date of birth, as YYYY-MM-DD or YYYY-MM." }, "peopleId": { "title": "Director id", "type": "string", "description": "The provider's own person identifier, when you already hold one." }, "localDirectorNumber": { "title": "Local director number", "type": "string", "description": "The local register's identifier for the director, such as the PNR in Great Britain." }, "language": { "title": "Search language", "type": "string", "description": "Language code for countries where a company is registered under more than one script or language, such as Japanese and English." }, "skipUnmatched": { "title": "Skip unmatched inputs", "type": "boolean", "description": "Leave unresolved identifiers and names out of the dataset entirely. By default they are stored with matched set to false, which is free, so you can see exactly which inputs failed to resolve.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Stop after this many records (1 to 25,000). You are charged per record returned." }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many records to request per call (1 to 200)." }, "useSandbox": { "title": "Use the sandbox environment", "type": "boolean", "description": "Send every request to the provider's sandbox instead of production. Useful for checking a filter set without consuming production report credits.", "default": false }, "apiUsername": { "title": "API username", "type": "string", "description": "Your provider username. Give this together with your password in the API key field and the actor authenticates by itself, renewing the token whenever it expires. Leave empty only if you are pasting a pre-issued token into the API key field instead." }, "apiKey": { "title": "API key", "type": "string", "description": "Your provider password when a username is given above, or a pre-issued authentication token when it is not. Required. Sent in a request header and never logged or placed in a URL." } } }, "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 } } }, "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 } } } } } } } } } }