https://api.getcurrent.ca/v1).
We note every change that a consumer could perceive — new fields, changed
behavior, deprecations, and fixes — and label anything breaking clearly.
Subscribe: an RSS feed for this page is generated automatically at
/changelog/rss.xml. Point your
reader (or a Slack RSS integration) at it to get notified of API changes.
Breaking changes are announced here before they ship, and API-key holders
are emailed directly. If a change isn’t marked Breaking, it is additive and
safe to adopt at your own pace.
Regulatory results: a comparable derivedStatus, and status now carries the registry’s own wording
Results under regulatory in POST /search and GET /search/{id} now carry
two status fields instead of one, splitting a job the single status
field was doing badly.Added: derivedStatus — a standardized standing that means the same
thing on every registry. This is the field to branch on:Changed:
status is now the registry’s own label, verbatim, and is
populated for every registry that publishes one — 15 of 23, up from 4. It
previously held a value we had normalized into our own vocabulary, and was
null for the rest even when the registry clearly published something.The type is unchanged (string | null) and no key was removed or renamed, so
responses still validate. Checked against every status value currently in our
indexes, the wording changes for two registries:fintracMsb’s "Expired", and every value on agcoCannabis and
bcCannabisRetail, are unchanged — those registries already published the
words we were reporting.And eleven registries that always returned status: null now return their
real label: craCharities ("Registered", "Revoked", "Annulled"),
rbqLicences, gleif, onBusinessLicences, nhpLicences,
ifoiFederalOrgs, agcoManufacturers, agcoLiquorSales,
agcoGroceryConvenience, calgaryBusinessLicences,
vancouverBusinessLicences.healthCanadaCannabis is the one registry that gains a derivedStatus
without gaining a status: Health Canada publishes no status column, and a
licence that is no longer in force is published as a status phrase in place
of its licence types. Reading that is our inference, not the registry’s own
wording, so it reports a standing and leaves status null.If you compare status against a fixed list of strings, move that logic to
derivedStatus. status is passthrough: each registry publishes its own
wording — "Issued", "Revoked", "LAPSED", "Annulée",
"Renewal Invoiced" — and that wording can change at the source without any
release on our side, so there has never been a fixed vocabulary to match on.
Treat status as a human-readable label to display or log.Note that inactive means “not currently in force”, which includes a pending
application that has not been granted yet. It is not a claim that anything
adverse happened — read status for that distinction.Treat unknown and null as “no answer”, never as a negative finding.
Several registries (WSIB, Ontario health service providers, the Alberta
gaming and cannabis sources and several municipal licence sources) publish no
status at all, and a record there will always be unknown.details is unaffected: where a registry’s status also appears there under
its own key (details.status, details.licenceStatus,
details.entityStatus, details.registrationStatus), it is unchanged.Match thresholds now use the 0–1 scale everywhere
Breaking./search and /sanctions took their match-confidence
thresholds as percentages (70–100) while /verify took the same concept
as a 0–1 fraction — and every score / matchScore the API reports is
0–1. That meant a confidence value you read out of a response could not be
passed back in as a threshold. All thresholds are now 0–1:Both the request and the echo in
meta.submitted move together, and
GET /search/{id} returns the same shape as POST /search. The accepted
range is unchanged in meaning: 0.7–1 where it used to be 70–100. A
value outside it returns 400.To migrate, divide your threshold by 100. /verify’s matching
thresholds were already 0–1 and are unaffected.Corrected field types — regenerate your API client
We auditedopenapi.yaml against the implementation and found 36 field
types that the spec got wrong. The API’s behaviour is not changing for
any of these — the responses were always shaped this way; the spec
described them incorrectly. But if you generate a typed client from our
spec, your bindings were wrong and may throw on values the API has always
been able to return. Regenerate.Genuinely different types (8)
The four threshold rows are the behaviour change described above. The rest were mis-documented.StatusFieldMatch is FieldMatch with nullable provided / registry —
not every business has a recorded status, business number or entity type.Documented as non-nullable, but can be null (23)
The most likely source of a null-pointer error in a typed client.Documented as nullable, but never null (5)
These are omitted when absent rather than returned as null.POST /sanctions always echoes source
meta.submitted.source was only present when you set source explicitly. It
is now always returned, defaulting to "current". The opensanctions path
also stopped dropping the rest of your submitted parameters (entityType,
countries, sources, dateOfBirth, typoTolerance, nameVariants) from
the echo, so both paths now return the same shape. Both are additive.Search & verify a stored business by id
POST /search and POST /verify now accept a reference to one of your stored
business records instead of re-supplying its details. Reference it by our id
with businessId, or by your own id on the record with the new
businessExternalId — the request fields (name/website for search; legal
name, jurisdiction, registration number, address, people for verify) are
hydrated from that record. Any field you also send overrides the record for
that request only; the stored record is never modified.name(search) andlegalName/jurisdiction/registrationNumber(verify) become optional when a reference is provided.- An unknown or foreign id returns
404 NOT_FOUND. Supplying bothbusinessIdandbusinessExternalIdthat point at different records returns400. - A
businessId-linked search compares its results against the record (the comparison / discrepancy view), same as a batch search.
/verify, the existing externalId field is your
reference id recorded as metadata on the verification result — it is not a
business lookup and never modifies the business record. Use the new
businessExternalId to look a business up by your own id.All changes are additive — existing requests are unaffected.API changelog is live
We now publish a dedicated changelog for the Current API. Going forward, every release that touches the/v1 surface — endpoints, request or response
shapes, webhooks, rate limits, or auth — gets an entry here, categorized as
Breaking, Added, Changed, Deprecated, or Fixed.Nothing about the API has changed in this entry — this is the starting point.
The current surface is documented in the API Reference.