curl --request POST \
  --url https://api.getcurrent.ca/v1/prefill \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Shopify"
}
'

{
  "query": "<string>",
  "mode": "name",
  "candidates": [
    {
      "legalName": "<string>",
      "matchScore": 0.5,
      "sources": [
        "business_registries"
      ],
      "operatingNames": [
        "<string>"
      ],
      "registrationNumbers": [
        {
          "type": "federal",
          "value": "<string>",
          "jurisdiction": "<string>",
          "label": "<string>"
        }
      ],
      "entityType": "<string>",
      "sourceEntityType": "<string>",
      "status": {
        "state": "<string>"
      },
      "incorporationDate": "<string>",
      "addresses": [
        {
          "street": "<string>",
          "city": "<string>",
          "province": "<string>",
          "postalCode": "<string>",
          "country": "<string>",
          "raw": "<string>"
        }
      ]
    }
  ],
  "candidateWebsites": [
    {
      "url": "<string>",
      "sources": [
        "business_registries"
      ],
      "matchScore": 0.5,
      "entityName": "<string>"
    }
  ],
  "sourcesSucceeded": [
    "business_registries"
  ],
  "sourcesFailed": [
    "business_registries"
  ],
  "searchedAt": "2023-11-07T05:31:56Z"
}

Pre-fill

Pre-fill Business

Fast typeahead lookup that returns ranked, already-canonical candidate business profiles for a name, business number (BN), or registration number. Designed to power an as-you-type autocomplete that auto-populates a business record — it is intentionally lightweight and does not run the full /search orchestration (no website analysis, sanctions, or report fetch).

Sources are queried in parallel and merged, then deduplicated and ranked. A slow or unavailable source is skipped without blocking the response — inspect sourcesSucceeded / sourcesFailed to see which contributed.

Identifier-shaped queries (BN, registration number) are auto-detected and exact matches are pinned to the top.

Typical response time: under 1 second.

POST

/

prefill

curl --request POST \
  --url https://api.getcurrent.ca/v1/prefill \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Shopify"
}
'

{
  "query": "<string>",
  "mode": "name",
  "candidates": [
    {
      "legalName": "<string>",
      "matchScore": 0.5,
      "sources": [
        "business_registries"
      ],
      "operatingNames": [
        "<string>"
      ],
      "registrationNumbers": [
        {
          "type": "federal",
          "value": "<string>",
          "jurisdiction": "<string>",
          "label": "<string>"
        }
      ],
      "entityType": "<string>",
      "sourceEntityType": "<string>",
      "status": {
        "state": "<string>"
      },
      "incorporationDate": "<string>",
      "addresses": [
        {
          "street": "<string>",
          "city": "<string>",
          "province": "<string>",
          "postalCode": "<string>",
          "country": "<string>",
          "raw": "<string>"
        }
      ]
    }
  ],
  "candidateWebsites": [
    {
      "url": "<string>",
      "sources": [
        "business_registries"
      ],
      "matchScore": 0.5,
      "entityName": "<string>"
    }
  ],
  "sourcesSucceeded": [
    "business_registries"
  ],
  "sourcesFailed": [
    "business_registries"
  ],
  "searchedAt": "2023-11-07T05:31:56Z"
}

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.

Show child attributes

candidateWebsites

object[]

required

Candidate official websites harvested for the query, ranked by match confidence. Always present (empty when none were found).

Show child attributes

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