# /resolve/companies/search

`POST /api/resolve/companies/search`

Price: 20 credits

Companies matching a name, best match first, each with the records our sources hold, its identifiers and the follow-up calls worth making next.

## How to use it

Use when you only have a company name; for a domain, URL or identifier use resolve/companies. Returns up to count companies ordered best first, and the first match is the best one; strong only marks an exact name two sources agree on and is not a reason to skip the first match. A match with an id opens next with resolve/companies calls, the first with that id; pass their params as-is. A match whose id is null has no resolve/companies call in next.

## Working with /resolve

Use /resolve/companies when you hold a domain, a company URL or an identifier; use /resolve/companies/search when you hold only a name. Each next entry is a ready call {endpoint, params}: source is the first path segment, category the second, endpoint all segments after source joined with _ (resolve/companies/search -> resolve, companies, companies_search; webparser/sitemap -> webparser, sitemap, sitemap); pass params as-is.

- name -> /resolve/companies/search -> the match with strong true -> its first next call (/resolve/companies)
- domain or company URL -> /resolve/companies -> the next calls the task needs

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `name` (string, required) — Company name (examples: "PostHog"; minLength: 1)
- `count` (integer, required) — Max number of companies to return (min: 1; max: 100)

## Response

### 200 — Successful Response

- `@type` (string) (default: "CompanyMatch")
- `id` (string, nullable) — Strongest identifier of the company that resolve/companies takes, as type:value; null when its records carry none (examples: "domain:posthog.com")
- `name` (string, required) — Company name as its best-matching record gives it (examples: "PostHog")
- `strong` (boolean, required) — The name matches exactly and at least two sources agree on the company through a shared identifier
- `links` (array) — Search records describing this company (default: [])
  - `@type` (string) (default: "MatchedRecord")
  - `source` (string, required) — Platform the record comes from (examples: "sitejabber")
  - `endpoint` (string, required) — Search endpoint that returned the record, callable as it is (examples: "sitejabber/businesses/search")
  - `record` (object, required) — The record exactly as that endpoint returns it
  - `partial` (boolean) — The source stopped before it answered in full (default: false)
- `identifiers` (object) — Every identifier of the company found in the records, by type: the primary value, the platforms carrying it and the other values found (default: {})
  - `*` (object)
    - `@type` (string) (default: "ResolvedIdentifier")
    - `value` (string, required) — Identifier value (examples: "stripe.com")
    - `sources` (array, required) — Platforms whose records carry this value
    - `alternatives` (array) — Other values of the same identifier carried by the records, most carried first (default: [])
      - `@type` (string) (default: "IdentifierValue")
      - `value` (string, required) — Identifier value (examples: "stripe.com")
      - `sources` (array, required) — Platforms whose records carry this value
- `not_found` (object) — Endpoints checked that gave no record, grouped by why
  - `@type` (string) (default: "NotFound")
  - `no_record` (array) — Endpoints that answered without a record (default: [])
  - `error` (array) — Endpoints that failed to answer (default: [])
  - `timeout` (array) — Endpoints that ran out of their time budget (default: [])
  - `skipped` (array) — Endpoints that do not take the identifier they were given (default: [])
- `next` (array) — Follow-up calls for this company, most used first, each with its payload filled in; when id is set, it opens with resolve/companies calls, one with id and one for each linked source id does not look up, which together return the full record of each linked source whose identifier a lookup takes, unless that source fails or answers without it (default: [])
  - `@type` (string) (default: "NextCall")
  - `endpoint` (string, required) — Endpoint to call next (examples: "webparser/render")
  - `params` (object, required) — Its payload, ready to send (examples: {"url":"https://stripe.com"})

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

No company matching the name was found.

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.