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

Free text: the company name plus anything you know, in one string ("Bamberger GmbH, Wien", "MFG Investments EOOD, from a UK filing", "Altria Group Inc., Richmond VA, altria.com"). The name and the hints are extracted for you. Give either query or name.

Example:

"Bamberger GmbH, Wien"

name
string

The company name alone, when you prefer to pass structured hints yourself. Legal-form suffixes, OCR noise and parenthesised aliases are handled.

Example:

"Bamberger GmbH"

hints
object
activeOnly
boolean

Only companies the registers report as active.

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 ranked candidates and the explained plan (JSON), or the SSE stream when stream is true.

status
enum<string>
required

resolved: one strong match. ambiguous: several plausible candidates, 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

Ranked candidates. Empty on not_found.

countries
object[]
required

The countries considered, and what happened in each.

steps
object[]
required

The search, step by step.

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