Skip to main content
POST

Authorizations

Authorization
string
header
required

API key as Bearer token: Authorization: Bearer cur_live_xxxxx

Body

application/json

Provide a name to search, or a businessId / businessExternalId to run the search against one of your stored business records. Any check flag omitted from the request falls back to your account's configured search settings (managed by an owner or admin in the dashboard); an explicit value in the request overrides that default.

name
string
required

Name of the company to search. Required unless businessId is provided, in which case it is taken from that record. A name in the request overrides the record's name for this search only.

Example:

"Shopify Inc"

website
string<uri>

Company website URL for additional analysis. When businessId is provided and this is omitted, the record's website is used.

Example:

"https://shopify.com"

businessId
string<uuid>

Run the search against one of your existing business records. Its name and website are used when omitted from the request, and the full record is snapshotted so the search's comparison / discrepancy view diffs the registry results against it. Must reference a business owned by your tenant, otherwise the request fails with 404 NOT_FOUND.

businessExternalId
string

Your own id for one of your stored business records (the external_id you set via CSV import or the businesses API). Resolves to that record exactly like businessId does — name/website are hydrated from it and the record is snapshotted for comparison. Unknown id → 404 NOT_FOUND. If both businessId and businessExternalId are supplied they must point at the same record, otherwise 400.

businessRegistry
boolean

Enable business registry search (provincial and federal). If omitted, uses your account's configured search settings.

regulatoryRegistry
boolean

Enable regulatory registry search (charities, MSB, cannabis). If omitted, uses your account's configured search settings.

regulatoryRegistryThreshold
integer

Minimum confidence score (70-100) for regulatory registry matches. If omitted, uses your account's configured search settings.

Required range: 70 <= x <= 100
sanctionsScreening
boolean

Enable sanctions screening against global watchlists. If omitted, uses your account's configured search settings.

sanctionsThreshold
integer

Minimum confidence score (70-100) for sanctions matches. If omitted, uses your account's configured search settings.

Required range: 70 <= x <= 100
websiteAnalysis
boolean

Enable website scraping and analysis. If omitted, uses your account's configured search settings.

Response

Search completed successfully

meta
object
required
businesses
object[]
required

Business registry results sorted by match confidence

regulatory
object
required

Regulatory registry matches — each key is a flat array (empty when no matches)

sanctions
object | null

Sanctions screening results — null when sanctionsScreening is not enabled

website
object

Website analysis results — only present when websiteAnalysis is true or website URL was provided

errors
object

Per-source errors — only present when one or more sources failed. Presence does not mean the search failed overall.