Skip to main content
POST
Find a company across countries from its name

Authorizations

x-api-key
string
header
required

Body

application/json
query
string
required

What you know about the company, in one string: the name first, then anything else, separated by commas ("Bamberger GmbH, Wien", "MFG Investments EOOD, from a UK filing", "Altria Group Inc., Richmond VA, altria.com", or an LEI alone). The name, the address, an identifier, a website and the countries it names are read out of it for you, and returned in query.

Example:

"Bamberger GmbH, Wien"

countries
string[]

Search only these countries: Topograph country codes, US-DE for one US state, US for every US state, CA-FED for the Canadian federal register, CA-ON for one Canadian province or territory, CA for every Canadian jurisdiction. Nothing outside them is searched or returned. Unlike a country named in query, which only says where you think the company is, this is a filter. Omit it to search every country.

Example:
activeOnly
boolean

Leave out companies the search sees as inactive. It filters on the same indicative status as isActive: a company whose status is unknown is kept, so a candidate is not proof that the company is active.

Example:

false

strictActiveOnly
boolean

Return only candidates explicitly reported as active, excluding unknown statuses. Implies activeOnly. Status remains indicative and may come from a periodic snapshot.

Example:

false

stream
boolean

Streaming mode: Server-Sent Events with progress events (the steps so far, and the candidates found so far), one complete event carrying the final response, or an error event. Set Accept to text/event-stream.

Example:

false

Response

The candidates and their explanations (JSON), or the SSE stream when stream is true.

id
string
required

Identifies this search. Quote it when you contact support about it.

Example:

"global-search-1791216000000-k3x9qa"

status
enum<string>
required

resolved: one strong match, the selected candidate. ambiguous: several plausible candidates (including namesakes in one register the evidence cannot tell apart), or one weak one. not_found: nothing acceptable; see reason.

Available options:
resolved,
ambiguous,
not_found
summary
string
required

The outcome in one sentence.

Example:

"Found in Austria: Bamberger GmbH (370916s)."

query
object
required

What was understood from your input.

candidates
object[]
required

Candidates, best first. Empty on not_found. On resolved, the first one is selected.

usage
object
required
reason
enum<string>

Why the search ended not_found, or why it stopped early.

Available options:
not_a_legal_entity,
no_country_signal,
country_not_covered,
no_register_match,
search_limit_reached,
timeout,
outside_countries
likelyCountryCode
string

The country the evidence points to, even when the company could not be confirmed, Topograph does not cover its register, or it is outside countries.

Example:

"KY"