{ "openapi": "3.0.1", "info": { "title": "Secretary of State Business Entity Search - KYB (CO, NY, CT)", "description": "Look up businesses in the Colorado, New York and Connecticut Secretary of State registries: status where published, registered agent, addresses, formation date and source URL, $0.02 per record. Optionally enroll a portfolio and get status, agent, name and address change events on your own schedule.", "version": "0.0", "x-build-id": "BaHsq4aqV26IUiB4m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yungstentech~merchant-registry-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yungstentech-merchant-registry-watch", "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/yungstentech~merchant-registry-watch/runs": { "post": { "operationId": "runs-sync-yungstentech-merchant-registry-watch", "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/yungstentech~merchant-registry-watch/run-sync": { "post": { "operationId": "run-sync-yungstentech-merchant-registry-watch", "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": [ "businesses" ], "properties": { "mode": { "title": "Mode", "enum": [ "check", "watch", "unwatch", "list-events" ], "type": "string", "description": "What this run does. check = a point-in-time registry record per business (a KYB evidence row). watch = enroll each business and, on this run, poll and diff it against its stored snapshot, delivering change events or a monthly attestation. unwatch = remove businesses from a watch. list-events = read back this watch's stored change-event history.", "default": "check" }, "businesses": { "title": "Businesses", "type": "array", "description": "The businesses to check or watch, 1 to 1000 items. Each item is { state, entityId } or { state, name }. state is CO, NY or CT. entityId is that state's own id: CO entityid, NY dos_id, CT accountnumber. A name-only entry is resolved against the state registry and enrolls ONLY on a unique exact match; an ambiguous name returns an uncharged candidate list to confirm by id. Required for check, watch and unwatch; optional for list-events." }, "watchName": { "title": "Watch name", "type": "string", "description": "Names this watch within your account so its memory (snapshots, event history, billing) persists across your scheduled runs. Lowercased, letters, digits and hyphens only, 1 to 40 characters. Use different names for different portfolios; each named watch is billed independently.", "default": "default" }, "sinceDays": { "title": "List-events window (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "For list-events mode: how many days of stored change-event history to return, 1 to 365. Ignored by other modes.", "default": 30 }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "Optional https URL that receives a POST with this run's change events (watch mode). Best-effort alerting only: the events dataset is the durable record. If you need to verify the caller, put a secret token in the URL yourself." }, "dryRun": { "title": "Dry run (preview, no PPE events)", "type": "boolean", "description": "When true, preview up to 5 rows total, charging no PPE events and writing no watch, no billing record and no event history. It still opens and reads named storage (and may provision it) and writes OUTPUT plus any preview rows actually produced to Dataset. This Actor's price covers platform usage on every run, so none of it is billed to you. The OUTPUT charged field reports whether PPE pricing is enabled for this run, not whether a charge landed. Use it to sanity check your businesses list before scheduling.", "default": false } } }, "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 } } } } } } } } } }