Skip to main content
POST

Authorizations

Authorization
string
header
required

API key as Bearer token: Authorization: Bearer cur_live_xxxxx

Body

application/json
query
string
required

Business name, business number (BN), or registration number. Identifier-shaped queries are auto-detected and exact matches are ranked first.

Minimum string length: 2
Example:

"Shopify"

limit
integer
default:10

Maximum number of candidates to return.

Required range: 1 <= x <= 25

Response

Ranked candidate businesses

query
string
required

The query that was processed (trimmed).

mode
enum<string>
required

How the query was interpreted. A ranking hint — all sources still run.

Available options:
name,
bn,
registration_number,
federal_corp_number
candidates
object[]
required

Ranked candidates (highest match first), capped at limit.

sourcesSucceeded
enum<string>[]
required

Sources that responded successfully (a source can succeed with zero matches).

A data source contributing candidates: business_registries Canadian Business Registries · federal_corporations Corporations Canada · orgbook_bc BC registry (OrgBook) · regulatory regulatory registries (charities, MSB, cannabis, etc.).

Available options:
business_registries,
federal_corporations,
orgbook_bc,
regulatory
sourcesFailed
enum<string>[]
required

Sources that timed out or errored. Their absence never blocks the response.

A data source contributing candidates: business_registries Canadian Business Registries · federal_corporations Corporations Canada · orgbook_bc BC registry (OrgBook) · regulatory regulatory registries (charities, MSB, cannabis, etc.).

Available options:
business_registries,
federal_corporations,
orgbook_bc,
regulatory
searchedAt
string<date-time>
required