{ "openapi": "3.0.1", "info": { "title": "New Jersey Business Registry Lookup & Name Checker", "description": "Look up New Jersey registered businesses by name, keyword or entity ID, and check whether a candidate business name is available for a new filing. Returns entity ID, entity type, city and incorporation date.", "version": "1.1", "x-build-id": "yzCQPRFfa7uWBW40K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~new-jersey-business-registry-lookup-and-name/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-new-jersey-business-registry-lookup-and-name", "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/vexaloom-labs~new-jersey-business-registry-lookup-and-name/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-new-jersey-business-registry-lookup-and-name", "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/vexaloom-labs~new-jersey-business-registry-lookup-and-name/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-new-jersey-business-registry-lookup-and-name", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "byName", "byKeyword", "byEntityId", "byLinkedName", "availability", "documents" ], "type": "string", "description": "What to fetch.", "default": "byName" }, "businessNames": { "title": "Business names", "type": "array", "description": "One or more names (mode=byName, availability). Name search is a prefix match: 'Amazon' finds names starting with Amazon, and a leading 'The' is ignored. Availability checks need a base name without a designator (no LLC, Inc., Corp., etc.) and at least 4 effective characters. Up to 50 names.", "items": { "type": "string" }, "default": [ "Amazon" ] }, "keywordSearches": { "title": "Keyword phrases", "type": "array", "description": "One or more keyword phrases (mode=byKeyword). Each phrase is split into words, and every word must appear in the business name; up to 5 words per phrase and 20 phrases.", "items": { "type": "string" }, "default": [] }, "entityIds": { "title": "Entity IDs", "type": "array", "description": "Exact 10-digit New Jersey entity IDs (mode=byEntityId, documents). Invalid IDs are reported in the run status instead of being dropped silently. Up to 200 IDs.", "items": { "type": "string" }, "default": [] }, "linkType": { "title": "Reverse search type", "enum": [ "principal", "registeredAgent", "associatedName" ], "type": "string", "description": "Which free Business Records Service search to use (mode=byLinkedName).", "default": "principal" }, "linkedName": { "title": "Linked name", "type": "string", "description": "Last name, business name, registered-agent name, or previous/alternate name to search (mode=byLinkedName)." }, "linkedFirstName": { "title": "Principal first name", "type": "string", "description": "Optional first name when linkType=principal (mode=byLinkedName)." }, "linkedMiddleName": { "title": "Principal middle name", "type": "string", "description": "Optional middle name when linkType=principal (mode=byLinkedName)." }, "linkedCity": { "title": "Linked city", "type": "string", "description": "Optional city filter for principal or registered-agent searches (mode=byLinkedName)." }, "entityTypes": { "title": "Entity types", "uniqueItems": true, "type": "array", "description": "Keep only these New Jersey entity types. Empty means no filter. Filters run on every page, not only after the 500-row display cap.", "items": { "type": "string", "enum": [ "NP", "FR", "DB", "LF", "DP", "LP", "NF", "PA", "LLC", "FLC", "LLP", "FLP", "GP", "FGP", "AUT", "NJR", "BDP" ], "enumTitles": [ "Non Profit Corporation", "Foreign Profit Corporation", "Foreign Corporation (DBA)", "Foreign Limited Partnership", "Domestic Profit Corporation", "Limited Partnership", "Foreign Non Profit Corporation", "Professional Corporation", "Domestic Limited Liability Company", "Foreign Limited Liability Company", "Domestic Limited Liability Partnership", "Foreign Limited Liability Partnership", "Partnership", "Foreign Partnership", "EDA Subsidiary", "Redevelopment Authority Subsidiary", "Benefit Domestic Profit Corporation" ] }, "default": [] }, "cityFilter": { "title": "City filter", "type": "string", "description": "Keep only businesses whose on-file city matches exactly (case-insensitive). Leave blank for all cities.", "default": "" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on emitted records (1-500, the source's display limit). Applied exactly, including when it is above 200.", "default": 100 } } }, "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 } } } } } } } } } }