{ "openapi": "3.0.1", "info": { "title": "New York DOS Business Entity Registry Lookup", "description": "Search New York's free public business entity registry by name, DOS ID number, registered agent, county, entity type, jurisdiction, city, or officer name, with formation date and address details.", "version": "1.1", "x-build-id": "KYrNb7RXr86YGAESj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xyrelith-data~new-york-dos-business-entity-registry-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xyrelith-data-new-york-dos-business-entity-registry-lookup", "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/xyrelith-data~new-york-dos-business-entity-registry-lookup/runs": { "post": { "operationId": "runs-sync-xyrelith-data-new-york-dos-business-entity-registry-lookup", "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/xyrelith-data~new-york-dos-business-entity-registry-lookup/run-sync": { "post": { "operationId": "run-sync-xyrelith-data-new-york-dos-business-entity-registry-lookup", "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": "Search mode", "enum": [ "byEntityName", "byIdentificationNumber", "byAssumedName", "byAssumedNameId", "byRegisteredAgent", "byCounty", "byEntityType", "byJurisdiction", "byCity", "byOfficerName", "byZipCode", "byState" ], "type": "string", "description": "What to search by. Fields labelled with a mode are only used by that mode.", "default": "byEntityName" }, "entityName": { "title": "Entity name (mode=byEntityName)", "type": "string", "description": "Legal business name to search for, e.g. `AMAZON` or `GOOGLE ACCESS`.", "default": "AMAZON" }, "entityNameMatchType": { "title": "Name match type (mode=byEntityName)", "enum": [ "startsWith", "contains", "exact" ], "type": "string", "description": "How the entity name is matched. `Exact match` is applied after the search returns.", "default": "startsWith" }, "idNumbers": { "title": "DOS ID number(s) (mode=byIdentificationNumber)", "type": "array", "description": "Exact New York DOS ID numbers. Pasted entity-page URLs are accepted.", "items": { "type": "string" } }, "assumedName": { "title": "Assumed name / DBA (mode=byAssumedName)", "type": "string", "description": "Doing-business-as name to search for, e.g. `AMAZON FRESH`." }, "assumedNameMatchType": { "title": "Assumed-name match type (mode=byAssumedName)", "enum": [ "startsWith", "contains" ], "type": "string", "description": "How the assumed name is matched.", "default": "contains" }, "assumedNameId": { "title": "Assumed name ID (mode=byAssumedNameId)", "type": "string", "description": "Exact New York assumed-name (DBA) ID, e.g. `6502000`." }, "agentName": { "title": "Registered agent name (mode=byRegisteredAgent)", "type": "string", "description": "Registered agent name to search for, e.g. `CT CORPORATION SYSTEM`. Active entities only." }, "agentMatchType": { "title": "Agent match type (mode=byRegisteredAgent)", "enum": [ "startsWith", "contains" ], "type": "string", "description": "How the registered agent name is matched.", "default": "contains" }, "county": { "title": "County (mode=byCounty)", "enum": [ "Albany", "Allegany", "Bronx", "Broome", "Cattaraugus", "Cayuga", "Chautauqua", "Chemung", "Chenango", "Clinton", "Columbia", "Cortland", "Delaware", "Dutchess", "Erie", "Essex", "Franklin", "Fulton", "Genesee", "Greene", "Hamilton", "Herkimer", "Jefferson", "Kings", "Lewis", "Livingston", "Madison", "Monroe", "Montgomery", "Nassau", "New York", "Niagara", "Oneida", "Onondaga", "Ontario", "Orange", "Orleans", "Oswego", "Otsego", "Putnam", "Queens", "Rensselaer", "Richmond", "Rockland", "Saratoga", "Schenectady", "Schoharie", "Schuyler", "Seneca", "St. Lawrence", "Steuben", "Suffolk", "Sullivan", "Tioga", "Tompkins", "Ulster", "Unknown", "Warren", "Washington", "Wayne", "Westchester", "Wyoming", "Yates" ], "type": "string", "description": "New York county of the entity's service-of-process address. Active entities only.", "default": "New York" }, "entityType": { "title": "Entity type (mode=byEntityType)", "enum": [ "DOMESTIC BENEFIT CORPORATION", "DOMESTIC BENEVOLENT ORDER", "DOMESTIC BUSINESS CORPORATION", "DOMESTIC CONDOMINIUM", "DOMESTIC CONDOMINIUM DECLARATION", "DOMESTIC COOPERATIVE CORPORATION", "DOMESTIC COOPERATIVE CORPORATION (WORKER COOPERATIVE)", "DOMESTIC DESIGN PROFESSIONAL SERVICE CORPORATION", "DOMESTIC GENERAL ASSOCIATION", "DOMESTIC GOVERNMENTAL AGENCY", "DOMESTIC HOUSING DEVELOPMENT FUND COMPANY (ARTICLE XI)", "DOMESTIC JOINT STOCK ASSOCIATION", "DOMESTIC LIMITED LIABILITY COMPANY", "DOMESTIC LIMITED PARTNERSHIP", "DOMESTIC LIMITED-PROFIT HOUSING COMPANY (ARTICLE 2 PHFL & BCL)", "DOMESTIC LIMITED-PROFIT HOUSING COMPANY (ARTICLE 2 PHFL & NPCL)", "DOMESTIC NOT-FOR-PROFIT CORPORATION", "DOMESTIC NOT-FOR-PROFIT CORPORATION (BOARD OF TRADE AND CHAMBER OF COMMERCE CORPORATION)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (COMMUNITY MENTAL HEALTH SERVICES AND MENTAL RETARDATION SERVICES COMPANIES)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (FIRE CORPORATION)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (HOUSING DEVELOPMENT FUND COMPANY) (ARTICLE XI)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (LAND BANK)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (LOCAL DEVELOPMENT CORPORATION)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (MILITIA ASSOCIATION)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (PUBLIC CEMETERY CORPORATION)", "DOMESTIC NOT-FOR-PROFIT CORPORATION (UNIVERSITY FACULTY PRACTICE CORPORATION)", "DOMESTIC PROFESSIONAL SERVICE CORPORATION", "DOMESTIC PROFESSIONAL SERVICE LIMITED LIABILITY COMPANY", "DOMESTIC PUBLIC BENEFIT CORPORATION", "DOMESTIC RAILROAD CORPORATION", "DOMESTIC REDEVELOPMENT COMPANY (ARTICLE V)", "DOMESTIC REDEVELOPMENT COMPANY (LIMITED LIABILITY COMPANY)", "DOMESTIC REDEVELOPMENT COMPANY (LIMITED PARTNERSHIP)", "DOMESTIC REGISTERED LIMITED LIABILITY PARTNERSHIP", "DOMESTIC RELIGIOUS CORPORATION", "DOMESTIC RELIGIOUS CORPORATION (GOVERNING OR ADVISORY BODY)", "DOMESTIC TRANSPORTATION CORPORATION", "FOREIGN BUSINESS CORPORATION", "FOREIGN COOPERATIVE CORPORATION", "FOREIGN DESIGNATION OF THE SECRETARY OF STATE", "FOREIGN GENERAL ASSOCIATION", "FOREIGN LIMITED LIABILITY COMPANY", "FOREIGN LIMITED PARTNERSHIP", "FOREIGN NOT-FOR-PROFIT CORPORATION", "FOREIGN PROFESSIONAL SERVICE CORPORATION", "FOREIGN PROFESSIONAL SERVICE LIMITED LIABILITY COMPANY", "FOREIGN RELIGIOUS CORPORATION", "GENERAL ASSOCIATION DESIGNATION", "NEW YORK REGISTERED FOREIGN LIMITED LIABILITY PARTNERSHIP", "RESERVATION OF DOMESTIC LIMITED LIABILITY COMPANY", "UNAUTHORIZED BUSINESS CORPORATION", "UNAUTHORIZED FOREIGN BUSINESS CORPORATION", "UNAUTHORIZED FOREIGN LIMITED LIABILITY COMPANY" ], "type": "string", "description": "Exact entity type recorded by NY DOS. Active entities only. For the broader official categories use `entityTypeCategories`.", "default": "DOMESTIC LIMITED LIABILITY COMPANY" }, "jurisdiction": { "title": "Jurisdiction of formation (mode=byJurisdiction)", "enum": [ "Alabama", "Alaska", "Alberta", "American Samoa", "Arizona", "Arkansas", "Armed Forces (Africa, Canada, Europe, Middle East)", "Armed Forces Pacific", "British Columbia", "CANAL ZONE", "CAROLINE ISLANDS", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "ENGLAND", "ENGLAND-WALES", "FEDERATED STATES OF MICRONESIA", "Florida", "Georgia", "Guam", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "MARSHALL ISLANDS", "Maine", "Manitoba", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "NEWFOUNDLAND", "NORTHERN IRELAND", "NORTHWEST TERRITORIES", "NUNAVUT", "Nebraska", "Nevada", "New Brunswick", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Nova Scotia", "Ohio", "Oklahoma", "Ontario", "Oregon", "PALAU", "PRINCE EDWARD ISLAND", "Pennsylvania", "Puerto Rico", "QUEBEC", "Rhode Island", "SASKATCHEWAN", "SCOTLAND", "South Carolina", "South Dakota", "Tennessee", "Texas", "U.S. Minor Outlying Islands", "U.S. Virgin Islands", "Utah", "Vermont", "Virginia", "WAKE ISLAND", "WALES", "Washington", "West Virginia", "Wisconsin", "Wyoming" ], "type": "string", "description": "State, territory, province or country where the entity was originally formed. Active entities only.", "default": "Delaware" }, "city": { "title": "City (mode=byCity)", "type": "string", "description": "City of the service-of-process address, e.g. `BROOKLYN`. Active entities only.", "default": "BROOKLYN" }, "cityMatchType": { "title": "City match type (mode=byCity)", "enum": [ "startsWith", "contains" ], "type": "string", "description": "How the city is matched.", "default": "startsWith" }, "officerName": { "title": "Officer/CEO name (mode=byOfficerName)", "type": "string", "description": "Officer, chairman or CEO name on file. Active entities only. Populated for a minority of entities." }, "officerMatchType": { "title": "Officer match type (mode=byOfficerName)", "enum": [ "startsWith", "contains" ], "type": "string", "description": "How the officer name is matched.", "default": "contains" }, "zipCode": { "title": "ZIP code (mode=byZipCode)", "type": "string", "description": "5-digit ZIP of the service-of-process address, e.g. `10001`. ZIP+4 is accepted and truncated. Active entities only.", "default": "10001" }, "state": { "title": "State (mode=byState)", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI", "AE", "AA", "AP", "MH", "PW", "CZ", "MW", "NA", "WK" ], "type": "string", "description": "2-letter state/territory code of the service-of-process address (not the formation jurisdiction). Active entities only.", "default": "NY" }, "entityStatus": { "title": "Entity status (official modes)", "enum": [ "AllStatuses", "Active", "Inactive", "Suspended" ], "type": "string", "description": "Filter by live DOS status: active, inactive or suspended. Applies to name, assumed-name and assumed-name ID searches. DOS-ID lookups always return the entity's real status. Legacy active-only browse modes ignore it.", "default": "Active" }, "entityTypeCategories": { "title": "Entity type categories (official modes)", "uniqueItems": true, "type": "array", "description": "Limit official name/assumed-name searches to one or more of the four DOS categories. Leave empty for all.", "items": { "type": "string", "enum": [ "Corporation", "LimitedLiabilityCompany", "LimitedPartnership", "LimitedLiabilityPartnership" ], "enumTitles": [ "Corporation", "Limited liability company", "Limited partnership", "Limited liability partnership" ] }, "default": [] }, "includeDetails": { "title": "Include full entity detail", "type": "boolean", "description": "Fetch each entity's detail record (section of law, CEO, stock, statement status, addresses, e-service). Adds one request per record.", "default": true }, "includeHistory": { "title": "Include filing and name history", "type": "boolean", "description": "Fetch name, filing, merger and assumed-name history for each record. Adds up to four requests per record.", "default": false }, "sortBy": { "title": "Sort results", "enum": [ "source", "newest", "oldest", "name" ], "type": "string", "description": "Order of the emitted records. `Source order` keeps the order returned by the registry.", "default": "source" }, "searchTerms": { "title": "Additional search terms", "type": "array", "description": "Extra names or DOS IDs searched in the same run and merged with the main term. Applies to name, assumed-name and DOS-ID modes.", "items": { "type": "string" } }, "formationDateFrom": { "title": "Formation date from (all modes)", "type": "string", "description": "Only include entities formed/registered on or after this date (`YYYY-MM-DD`)." }, "formationDateTo": { "title": "Formation date to (all modes)", "type": "string", "description": "Only include entities formed/registered on or before this date (`YYYY-MM-DD`)." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on emitted records (1-5000).", "default": 25 } } }, "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 } } } } } } } } } }