{ "openapi": "3.0.1", "info": { "title": "Company Registry Lookup (GLEIF, UK, France)", "description": "Look up or match companies in the GLEIF LEI register, UK Companies House and the French company register. Company-level data only.", "version": "1.0", "x-build-id": "umV4a6xwDR8VCKOqo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jetlaunch~company-registry-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jetlaunch-company-registry-lookup", "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/jetlaunch~company-registry-lookup/runs": { "post": { "operationId": "runs-sync-jetlaunch-company-registry-lookup", "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/jetlaunch~company-registry-lookup/run-sync": { "post": { "operationId": "run-sync-jetlaunch-company-registry-lookup", "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": [ "queries" ], "properties": { "mode": { "title": "Mode", "enum": [ "entity-match", "entity-lookup" ], "type": "string", "description": "Entity match searches each company name across the enabled registers and returns ranked matches (billed once per name that returns results). Entity lookup returns the full record for each identifier or name (billed per entity returned).", "default": "entity-match" }, "queries": { "title": "Company names or identifiers", "maxItems": 500, "type": "array", "description": "One entry per line. In match mode each entry is a company name. In lookup mode each entry can be an LEI (20 characters), a UK company number (for example 00000006 or SC123456), a French SIREN (9 digits) or SIRET (14 digits), or a company name. Up to 200 names in match mode, 500 entries in lookup mode.", "items": { "type": "string" } }, "includeGleif": { "title": "Include GLEIF (global LEI register)", "type": "boolean", "description": "Search and look up legal entities with a Legal Entity Identifier. No key needed. GLEIF data is published under CC0.", "default": true }, "includeFrance": { "title": "Include French company register", "type": "boolean", "description": "Search and look up French companies through the government company search API (data from Sirene and the RNE). No key needed. Sole traders and non-public units are never returned.", "default": true }, "includeUk": { "title": "Include UK Companies House", "type": "boolean", "description": "Search and look up UK companies. This needs your own free Companies House API key below. Without a key this source is skipped and nothing is charged for it.", "default": false }, "companiesHouseApiKey": { "title": "Companies House API key", "type": "string", "description": "Your own free key from developer.company-information.service.gov.uk (register an API key application). It is stored encrypted, used only for requests to Companies House and never written to the output. The Actor is limited to 600 requests per 5 minutes per key, which is the Companies House limit." }, "maxMatches": { "title": "Maximum matches per name", "minimum": 1, "maximum": 50, "type": "integer", "description": "Match mode only. How many ranked matches to return for each name across all registers.", "default": 10 }, "minScore": { "title": "Minimum match score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Name similarity from 0 to 100. A score of 100 means the names are identical once case, accents, punctuation and legal-form words such as Ltd, SAS or AG are ignored. Matches below this score are dropped.", "default": 40 }, "matchesPerName": { "title": "Entities per name (lookup mode)", "minimum": 1, "maximum": 5, "type": "integer", "description": "Lookup mode only. When an entry is a company name, return the full record for this many best matches. Each entity returned is billed.", "default": 1 }, "includeRelationships": { "title": "Include GLEIF parents and children", "type": "boolean", "description": "Lookup mode only. Add direct parent, ultimate parent and direct children for GLEIF records. Makes the lookup slower (three extra requests per GLEIF record).", "default": true }, "maxChildren": { "title": "Maximum children listed", "minimum": 0, "maximum": 50, "type": "integer", "description": "Lookup mode only. How many direct children to list per GLEIF record. The total count is always given.", "default": 10 }, "includeFilingCounts": { "title": "Include UK filing counts", "type": "boolean", "description": "Lookup mode only. Add the number of filings on the Companies House filing history (one extra request per UK company).", "default": true } } }, "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 } } } } } } } } } }