{ "openapi": "3.0.1", "info": { "title": "Business Registry Search: Status, Type, Formation Date, LEI", "description": "Company registry search: verify companies by name or id in official open registries (New York, Colorado and Connecticut state records, global GLEIF LEI index). Legal name, entity type, status, formation date, jurisdiction, address, LEI. No officers, agents or emails. USD 0.90 per 1,000 records.", "version": "1.0", "x-build-id": "z2VNi1oDfWugaTZ32" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jtpalms~company-registry-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jtpalms-company-registry-search", "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/jtpalms~company-registry-search/runs": { "post": { "operationId": "runs-sync-jtpalms-company-registry-search", "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/jtpalms~company-registry-search/run-sync": { "post": { "operationId": "run-sync-jtpalms-company-registry-search", "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": { "companyNames": { "title": "Company names", "type": "array", "description": "Names to look up, one per line. Case, punctuation and the legal form are ignored when matching (\"Stripe Inc\" finds \"STRIPE, INC.\"). Duplicates are looked up once.", "items": { "type": "string" } }, "entityIds": { "title": "Registry ids or LEIs (optional)", "type": "array", "description": "Exact lookups: an LEI (20 characters), or a registry number with an optional prefix for the state: NY:7858078 (New York DOS id), CO:20151186339 (Colorado entity id), CT:1175082 (Connecticut business id). A number without a prefix is tried in every chosen state.", "items": { "type": "string" } }, "matchMode": { "title": "Name match", "enum": [ "prefix", "exact", "contains" ], "type": "string", "description": "Starts with: the registry name begins with your words (fast, the default). Exact: the same name once the legal form (Inc, LLC, Corp...) is ignored. Contains: your text appears anywhere in the name (slower on New York; the LEI index matches whole words only).", "default": "prefix" }, "jurisdictions": { "title": "Registries", "type": "array", "description": "Which registries to search. Empty = all four. LEI is the global GLEIF index (every country). Oregon was studied and left out: its portal's terms do not allow commercial redistribution.", "items": { "type": "string", "enum": [ "US-NY", "US-CO", "US-CT", "LEI" ], "enumTitles": [ "New York (Department of State)", "Colorado (Secretary of State)", "Connecticut (Secretary of the State)", "LEI (GLEIF global index)" ] }, "default": [ "US-NY", "US-CO", "US-CT", "LEI" ] }, "onlyActive": { "title": "Active entities only", "type": "boolean", "description": "Return only entities the registry still lists as existing (Colorado's delinquent entities included, flagged with goodStanding false). Switch off to also see dissolved, withdrawn, revoked and merged ones (Colorado, Connecticut and LEI; the New York dataset holds active entities only).", "default": true }, "entityTypes": { "title": "Entity types", "type": "array", "description": "Keep only these types (normalised across registries). Empty = all.", "items": { "type": "string", "enum": [ "corporation", "llc", "lp", "llp", "nonprofit", "cooperative", "trust", "partnership", "fund", "branch", "other" ], "enumTitles": [ "Corporation", "LLC", "Limited partnership", "LLP", "Nonprofit", "Cooperative", "Trust", "General partnership", "Fund (LEI only)", "Branch (LEI only)", "Other" ] } }, "maxResultsPerSource": { "title": "Results per name and registry", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Best matches kept for each name in each registry (highest match score first).", "default": 10 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many records for the whole run. Each record is one charged event.", "default": 1000 }, "minMatchScore": { "title": "Minimum match score", "minimum": 0, "maximum": 1, "type": "number", "description": "From 0 to 1. 1 = the same name and legal form, 0.95 = the same name with another legal form, lower = the name starts with or contains your words. 0 keeps every match.", "default": 0 }, "matchLei": { "title": "Attach LEIs to state records", "type": "boolean", "description": "Look the same name up in the GLEIF index and add the LEI to a state record when it is the same entity (same registry number, or the same legal name and jurisdiction of formation). The matched LEI is then not repeated as its own row.", "default": true }, "includeAddress": { "title": "Include street address", "type": "boolean", "description": "Business address of the entity as the registry lists it (principal office, business address or, in New York, the service-of-process address when it is addressed to the entity itself). Off = city, region and postal code only.", "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 } } } } } } } } } }