{ "openapi": "3.0.1", "info": { "title": "US Business Entity Search & Status Check — 7 States", "description": "Check company status across official state registries in one run: New York, Texas, Florida, Pennsylvania, Colorado, Connecticut and Oregon. Search by name or state ID; get status, type, formation date and address. No person data. Part of NexGen Signal — official-source data products", "version": "0.3", "x-build-id": "Hw3xBulqv0GDRyNar" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgensignal~us-business-entity-status-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgensignal-us-business-entity-status-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/nexgensignal~us-business-entity-status-check/runs": { "post": { "operationId": "runs-sync-nexgensignal-us-business-entity-status-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/nexgensignal~us-business-entity-status-check/run-sync": { "post": { "operationId": "run-sync-nexgensignal-us-business-entity-status-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": { "names": { "title": "Company names", "type": "array", "description": "Company names to check in every selected state (up to 500). Case, commas, periods and apostrophes are ignored.", "default": [], "items": { "type": "string" } }, "matchMode": { "title": "Name matching", "enum": [ "exact", "startsWith", "contains" ], "type": "string", "description": "Exact: 'Acme Roofing LLC' finds 'ACME ROOFING, L.L.C.' only when the words match. Starts with: every entity whose name begins with your text. Contains: every entity whose name includes your text (4+ letters).", "default": "exact" }, "entityIds": { "title": "State entity IDs", "type": "array", "description": "Look up by the state's own ID as STATE:ID, e.g. NY:4424185 (DOS ID), CO:19871342214, CT:0101743 (account number), OR:299818 (registry number), PA:0006436709 (filing number), TX:32107728928 (taxpayer or SOS file number), FL:P26000046350 (document number).", "default": [], "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Which state registries to check for your names. Florida is off by default because it is read from the State's full file, which takes several minutes.", "items": { "type": "string", "enum": [ "NY", "CO", "CT", "OR", "PA", "TX", "FL" ], "enumTitles": [ "New York", "Colorado", "Connecticut", "Oregon", "Pennsylvania", "Texas", "Florida (reads the full State file: 3–7 minutes)" ] }, "default": [ "NY", "CO", "CT", "OR", "PA", "TX" ] }, "maxMatchesPerName": { "title": "Maximum matches per name per state", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Caps how many entities one name can return in one state (useful with Starts with / Contains).", "default": 25 }, "maxRecords": { "title": "Maximum records", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many records. You are charged per record delivered.", "default": 500 } } }, "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 } } } } } } } } } }