/new_york/companies/search

POST /api/new_york/companies/search

Price: 1 credit

Search New York business entities in the NY Department of State Corporation & Business Entity Database by name or DOS ID. Returns matching entities with DOS ID, name, company type and status, type category, name type, assumed name and assumed-name ID, non-qualified ID, jurisdiction, county and initial filing date.

How to use it

Search New York business entities by name or DOS ID. Pass query and count; optionally search_by (EntityName/DOS ID/Assumed Name/Assumed Name ID), match (BeginsWith/Contains), status (AllStatuses/Active/Inactive) and entity_types (Corporation/LimitedLiabilityCompany/LimitedPartnership/LimitedLiabilityPartnership). Returns a list of items, each with dos_id, name, company_type, entity_status, company_type_category, name_type, assumed_name, assumed_name_id, non_qualified_id, jurisdiction, county and initial_filing_date (ISO YYYY-MM-DD). Returns an empty list when nothing matches. Use the dos_id with new_york/companies for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search value — entity name or DOS ID (examples: "WALMART"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• search_by string — Field to search by (default: "EntityName"; one of: "EntityName", "DOSID", "AssumedName", "AssumedNameID")
• match string — Name matching mode (default: "BeginsWith"; one of: "BeginsWith", "Contains")
• status string — Entity status filter (default: "AllStatuses"; one of: "AllStatuses", "Active", "Inactive", "Suspended")
• entity_types array — Entity types to include in the search (default: ["Corporation","LimitedLiabilityCompany","LimitedPartnership","LimitedLiabilityPartnership"]; one of: "Corporation", "LimitedLiabilityCompany", "LimitedPartnership", "LimitedLiabilityPartnership")

Response

• @type string (default: "NewYorkSearchItem")
• dos_id string required
• name string required
• company_type string nullable
• entity_status string nullable
• company_type_category string nullable
• name_type string nullable
• assumed_name string nullable
• assumed_name_id string nullable
• non_qualified_id string nullable
• jurisdiction string nullable
• county string nullable
• initial_filing_date string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.