Skip to main content
GET
Fuzzy company lookup by name

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

name
string
required

Free-text company name. Case- and punctuation-insensitive; common suffixes like 'Pty Ltd', 'Limited', and 'The Trustee For' are stripped before matching.

Required string length: 1 - 1000
state

Optional AU state/territory filter: keeps companies with ANY office in that state (the same rule as search's state), not only those headquartered there. Useful when several companies share a name across jurisdictions.

Available options:
NSW
limit
integer
default:5

Maximum number of candidates to return (default 5, max 25).

Required range: 1 <= x <= 25
tz
string

IANA timezone (e.g. Australia/Sydney, the default) used to render signals.news.last_published_at as a calendar day and to interpret news_published_after as local midnight. Unknown zones are rejected with 400.

Maximum string length: 64

Response

Fuzzy-name lookup result. best_match is set when one candidate clearly dominates (top score ≥ 0.85 AND a margin to the runner-up: ≥ 0.15 on the exact/words_in_order/trigram rungs, ≥ 0.05 on the graded prefix rung — a word-boundary completion like 'aldi' → 'aldi stores' scores in [0.95, 0.99) and a mid-word one like 'aldi' → 'aldinga …' in [0.85, 0.89), so a boundary hit over a mid-word runner-up resolves and two same-class hits do not) OR when a unique exact match was found; otherwise null and the LLM should ask the user to disambiguate from candidates.

Fuzzy-name lookup result. best_match is set when one candidate clearly dominates (top score ≥ 0.85 AND a margin to the runner-up: ≥ 0.15 on the exact/words_in_order/trigram rungs, ≥ 0.05 on the graded prefix rung — a word-boundary completion like 'aldi' → 'aldi stores' scores in [0.95, 0.99) and a mid-word one like 'aldi' → 'aldinga …' in [0.85, 0.89), so a boundary hit over a mid-word runner-up resolves and two same-class hits do not) OR when a unique exact match was found; otherwise null and the LLM should ask the user to disambiguate from candidates.

best_match
object | null
required

The one candidate that clearly dominates (score, match_kind, matched_on, and its short company card), or null when the caller should ask the user to choose from candidates.

candidates
object[]
required

The other candidates, sorted best-first, each with a short company card; never includes the best_match. best_match plus candidates hold at most limit companies. Useful for chat-window "or did you mean…" UX.