Skip to main content
POST

Authorizations

Authorization
string
header
required

API key as Bearer token: Authorization: Bearer cur_live_xxxxx

Body

application/json

Supply the identity fields directly, or reference one of your stored business records by businessId (our id) or businessExternalId (your own id on the record) — its legal name, jurisdiction, registration number (and address / people) are hydrated from that record. Any field you also supply in the request overrides the record for this verification only; the stored record is never modified.

Legal name of the business to verify. Required unless businessId or businessExternalId is provided.

Example:

"Shopify Inc."

jurisdiction
string
required

Canadian jurisdiction code (AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT, FED) or full name (e.g. "Ontario", "British Columbia", "Federal"). Required unless businessId or businessExternalId is provided.

Example:

"ON"

registrationNumber
string
required

Business registration number assigned by the provincial or federal registry. Required unless businessId or businessExternalId is provided.

Example:

"2033076"

businessId
string<uuid>

Verify one of your existing business records. When provided, legalName / jurisdiction / registrationNumber (and address / people) become optional and are taken from the record. Must reference a business owned by your tenant, otherwise the request fails with 404 NOT_FOUND. If the record is missing a required identity field the request fails with 400.

businessExternalId
string

Reference a stored business record by your own id on it (its external_id) instead of businessId — same behavior. Unknown id → 404 NOT_FOUND (never creates a business). If both businessId and businessExternalId are supplied they must point at the same record, otherwise 400. (Distinct from externalId, which is result metadata, not a lookup.)

address
object

Address fields to verify against the registry. All fields are optional — only provided fields are compared.

people
object[]

People to verify against registry directors/officers. People matching is enabled by default; set matching.people.enabled: false to skip it.

externalId
string

Your own reference id for this verification (e.g. a CRM record id). Recorded as metadata on the verification RESULT so you can find verifications by your own identifiers. This is NOT a business lookup and never modifies the business record — to reference a stored business by your own id, use businessExternalId.

Example:

"ref_1Nxxx"

matching
object

Per-request overrides for your account's verification settings. The default shown on each field is the out-of-the-box value used when you haven't customized your account settings and omit the field here.

Response

Verification completed (check status field — may be verified or not_verified)

meta
object
required
results
object
required
registryData
object
required

Registry data fetched and used for verification