{ "openapi": "3.0.1", "info": { "title": "US Business Entity Search (KYB) - CO, NY, CT, OR, TX registries", "description": "Look up companies by name, entity ID or registered agent/officer in official state registries (Colorado, New York, Connecticut, Oregon, Texas): status, type, formation date, addresses, registered agent, officers, NAICS. Bulk KYB with match scores; misses are free.", "version": "0.1", "x-build-id": "sYWS5UbSwUK2hcLUH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/larkmoor~us-business-entity-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-larkmoor-us-business-entity-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/larkmoor~us-business-entity-search/runs": { "post": { "operationId": "runs-sync-larkmoor-us-business-entity-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/larkmoor~us-business-entity-search/run-sync": { "post": { "operationId": "run-sync-larkmoor-us-business-entity-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": { "names": { "title": "Company names", "type": "array", "description": "Company names to look up (one per line). Each name is searched in every selected state; the best matches come first with a matchScore (1.0 = same name once LLC/Inc/Corp are ignored).", "items": { "type": "string" } }, "entityIds": { "title": "Entity / file numbers", "type": "array", "description": "State entity IDs to look up. Prefix with the state to avoid collisions, e.g. CT:2770540, CO:20071359978, NY:6326456, OR:299818, TX:0806762076 (TX accepts the SOS file number or the 11-digit taxpayer number).", "items": { "type": "string" } }, "agentOrOfficerNames": { "title": "Registered agent / officer names", "type": "array", "description": "Find every entity tied to a person or company acting as registered agent, officer, director or authorized representative (CO agents, NY agent/process/CEO, CT agents + principals, OR agents + representatives). Texas publishes no names, so it is skipped here.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Registries to search. Default: all five.", "items": { "type": "string", "enum": [ "CO", "NY", "CT", "OR", "TX" ], "enumTitles": [ "Colorado (all statuses, agent)", "New York (active entities, agent, CEO)", "Connecticut (all statuses, agent, officers, NAICS, email)", "Oregon (active, agent, representatives)", "Texas (active franchise taxpayers, SOS file no.)" ] }, "default": [ "CO", "NY", "CT", "OR", "TX" ] }, "matchMode": { "title": "Name match", "enum": [ "contains", "allWords", "startsWith", "exact" ], "type": "string", "description": "How names are matched. 'contains' still ranks exact and starts-with matches first.", "default": "contains" }, "activeOnly": { "title": "Active entities only", "type": "boolean", "description": "Drop dissolved, withdrawn, revoked or forfeited entities (CO and CT carry every status; NY, OR and TX publish active entities only).", "default": false }, "minMatchScore": { "title": "Minimum match score (0-1)", "type": "string", "description": "Optional, e.g. 0.8 keeps only close name matches for KYB checks. Empty = keep all." }, "includeOfficers": { "title": "Include officers / principals", "type": "boolean", "description": "Add officers, directors and authorized representatives where the state publishes them (CT, OR, NY CEO). Business addresses only; home addresses are never returned.", "default": true }, "maxResultsPerQuery": { "title": "Max matches per name per state", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Max matches per query in each state. Default: 10. Use 1 with exact names for a one-row-per-company KYB check.", "default": 10 }, "maxResults": { "title": "Max entities in total", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after this many entities. Default: 1000.", "default": 1000 }, "includeNotFound": { "title": "Add a free 'not found' row for names with no match", "type": "boolean", "description": "Keeps a bulk KYB list complete: each query with no match in any selected state gets one row with found=false (not charged).", "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 } } } } } } } } } }