Operator detail — metadata + licences + domains

Authorizations

bearerAuth

Path Parameters

slug

required

string

Query Parameters

as_of

string

Point-in-time lookup. Each licence gains an as_of object (status reconstructed within our observation window — never extrapolated before tracking_since). Bare YYYY-MM-DD = end of day UTC; ISO datetime supported; a future value 400s.

Example

2026-03-01

200

Operator detail.

object

operator

required

object

id

string format: uuid

slug

string

display_name

string

registered_name

string | null

country

string | null

upstream_ids

object

key

additional properties

string

trading_names

Array<string>

created_at

string format: date-time

updated_at

string format: date-time

{
  "id": "9d6f21e0-7f34-4b3a-b0a8-ec6c3cab3e11",
  "slug": "power-leisure-bookmakers-limited",
  "display_name": "Power Leisure Bookmakers Limited",
  "registered_name": "paddy power",
  "country": "GB",
  "upstream_ids": {
    "UKGC": "39028"
  },
  "trading_names": [
    "paddy power"
  ],
  "created_at": "2026-04-17T15:15:41.414Z",
  "updated_at": "2026-04-19T03:01:12.200Z"
}

licenses

required

Array<object>

object

id

string format: uuid

license_number

string

jurisdiction_code

string

status

Canonical licence status. Only active means “licensed right now”. Every other value is “not a pass” — but three of them are not enforcement decisions, and a rule that lumps them in with revoked publishes a claim about a real business that no regulator made.

not_in_register — the regulator’s public register no longer lists this licence, since not_listed_since. An observation about the register, not a decision by the regulator: licences drop off because they expired, were surrendered, were renumbered, or the page had a bad day. Nobody published a reason and we do not invent one. It is not a revocation. (Until 2026-09-17 we reported this as revoked; that was wrong, every affected record has been corrected, and its history says so.)

surrendered — the operator gave the licence up (UKGC publishes “Surrendered”; Kahnawake “voluntary termination … in good standing”). Also not an enforcement decision: nobody took it away. 627 UKGC licences carried revoked for this until 2026-09-17.

unknown — the register lists this licence and published a status we could not classify: a new phrase, a reworded sentence, a typo. We do not guess: two of our scrapers used to default an unreadable status to active, and that is precisely the bug this value exists to make impossible. Read upstream_status for the regulator’s own words.

None of these is a synonym for any other:

None of them means “not licensed” in the enforcement sense. Do not present them as such.
None of them means “probably fine”. Do not treat them as a pass.

A rule like if (status === "revoked") block() will silently let surrendered, not_in_register and unknown through. If your flow makes an automated allow/deny decision, approve only on active and escalate everything else to a human.

revoked and suspended are only ever set from a regulator publication we actually read — an enforcement register, a revoked-licences page, an explicit status column — never from a licence disappearing.

string

Allowed values: active suspended revoked expired pending unknown surrendered not_in_register

license_types

Multi-valued type vocabulary, sourced verbatim from the regulator. Stable values per jurisdiction (audited 2026-04-21):

UKGC — Remote, Non-Remote, Ancillary Remote
MGA — Type 1, Type 2, Type 3, Type 4, B2B, B2C
CW (Curaçao) — B2C, B2B
KH (Kahnawake) — Interactive Gaming Permit, CSPA
AN (Anjouan) — B2C, B2B, White Labeling
TGC (Tobique) — B2C, B2B

Add a new value to your client mapping when a regulator publishes one — we don’t reject unknown strings. Multi-jurisdiction operators carry one license row per jurisdiction, so this array is per-licence.

Array<string>

license_type_raw

string

not_listed_since

When the regulator’s public register stopped listing this licence (first pull that missed it) — the date behind status: not_in_register. null = listed in the most recent pull. An observation about the register, not a regulator decision: it does not mean revoked. A licence can briefly carry this while still active (one missed pull, inside our grace window).

string | null format: date-time

license_category

Cross-jurisdiction harmonised category — derived by @igregulator/normalizer so a multi-regulator query can group by it. UKGC Remote, MGA Type 1/2, CW B2C map to remote; UKGC Non-Remote to non-remote; etc.

string

Allowed values: remote non-remote ancillary permit other

issued_date

string | null format: date

expiry_date

string | null format: date

last_verified_at

string format: date-time

source_url

string format: uri

raw_data

Scraper-specific fields captured verbatim from the upstream register (e.g. UKGC activity categories, CGA company-type flags). Not a stable integration surface. Keys here are added, renamed, or removed without a deprecation window when a scraper is updated — they do not carry the 90-day Sunset guarantee that top-level fields do. Use license_types, license_category, status, issued_date, expiry_date for stable compliance logic; read raw_data only for diagnostic / investigative purposes.

object

key

additional properties

any

as_of

Point-in-time status, present only when ?as_of= was supplied. Answers ONLY within the observation window: we never extrapolate a status before tracking_since (the first time we recorded the licence).

object

as_of

required

The resolved instant (UTC). Bare YYYY-MM-DD inputs resolve to end-of-day.

string format: date-time

knowledge

required

observed: the date is within our window, status is known. corrected: the event in effect on that date is one we later WITHDREW (see correction) — status is null. We do not report the withdrawn status, and we do not fall back to the one before it either: neither is something we observed for that date. before_tracking: the date predates when we started watching — status is null, NOT a guess. no_such_license: we have no history for this licence. no_license_resolved: a fuzzy /v1/check match with no specific licence to time-travel.

string

Allowed values: observed corrected before_tracking no_such_license no_license_resolved

status_as_of

required

Licence status as of the date, or null when not observed.

string | null

established_by

required

The history transition in effect at the date — when this status was last confirmed relative to the query.

object

changed_at

string format: date-time

new_status

string

change_type

string

source_url

string

correction

Present only when knowledge is corrected. The event that was in effect at the date and that we later withdrew. withdrawn_status is what we USED to say — never quote it as the status.

object

changed_at

string format: date-time

withdrawn_status

string

corrected_at

string format: date-time

note

string | null

tracking_since

required

Lower bound of our knowledge — when we first observed this licence.

string | null format: date-time

{
  "id": "d29fbc19-3ed3-4043-8a74-e001491feb24",
  "license_number": "039028-R-319297-013",
  "jurisdiction_code": "UKGC",
  "status": "active",
  "license_types": [
    "Remote"
  ],
  "license_type_raw": "Remote",
  "license_category": "remote",
  "issued_date": "2014-11-01",
  "expiry_date": null,
  "last_verified_at": "2026-04-19T03:00:12.480Z",
  "source_url": "https://www.gamblingcommission.gov.uk/downloads/business-licence-data.zip",
  "raw_data": {
    "activities": [
      "Bingo",
      "Casino"
    ]
  }
}

domains

required

Array<object>

object

domain

string

status

string

association

string

Allowed values: direct white_label

first_seen

string format: date-time

last_verified

string format: date-time

_meta

required

One of:

object
null

Single-resource provenance envelope — answers “where did this come from and how fresh is it?” for one record.

object

scraped_at

required

ISO-8601 timestamp when iGregulator’s scraper last fetched this record.

string format: date-time

source_modified_at

required

ISO-8601 timestamp when the regulator updated the data on their register, not when our scraper fetched it. Always null today across every jurisdiction — our schema doesn’t persist per-record upstream modification time. Will populate for UKGC (the one regulator that exposes it via the ZIP’s last_updated field) once the scraper migration lands; remains null for MGA, CGA, KGC (no upstream timestamp).

string | null format: date-time

source_url

required

The regulator page this answer rests on. For a licence — including a /v1/check match — it is the page that published the licence’s current STATUS (status_source_url: an enforcement register, a revoked-licences list, an advisory notice), falling back to the register the licence is listed in when they are the same page. Null when not attributable to a single URL.

string | null format: uri

confidence_hint

required

authoritative — direct from an official regulator dump (e.g. UKGC ZIP). scraped — parsed from regulator HTML/PDF (MGA, CGA, KGC). derived — computed match, not a direct lookup (fuzzy match on /v1/check, no direct source row).

string

Allowed values: authoritative scraped derived

{
  "scraped_at": "2026-04-19T03:00:00Z",
  "source_modified_at": null,
  "source_url": "https://www.gamblingcommission.gov.uk/downloads/business-licence-data.zip",
  "confidence_hint": "authoritative"
}

401

Missing / malformed / revoked API key.

object

error

required

Human-readable error summary.

string

code

required

HTTP-status-level class. Stable enum; branch on details.reason for finer control. Current values: invalid_query, invalid_slug, invalid_license_id, invalid_jurisdiction_code, invalid_pagination, not_found, auth_required, auth_invalid, auth_revoked, payment_required, quota_exceeded, rate_limited, server_error.

string

details

required

object

reason

required

Machine-readable refinement of the top-level code. Stable vocabulary; branch on this in clients. Examples: invalid_input, missing_required_parameter, conflicting_parameters, operator_not_found, license_not_found, jurisdiction_not_found, route_not_found, api_key_missing, malformed_header, api_key_invalid, api_key_revoked, quota_exceeded, internal_error.

string

field

Present only when the error maps to a specific request input field (query param, path param, body key). Omitted for errors that aren’t field-scoped (e.g. rate_limited, auth_revoked).

string

suggestion

Optional human-readable / agent-actionable hint describing how to resolve the error.

string

{
  "reason": "api_key_revoked",
  "suggestion": "Generate a new API key at https://app.igregulator.io/settings. Revoked keys cannot be restored."
}

{
  "error": "API key has been revoked",
  "code": "auth_revoked",
  "details": {
    "reason": "api_key_revoked",
    "suggestion": "Generate a new API key at https://app.igregulator.io/settings. Revoked keys cannot be restored."
  }
}

404

No row matched.

object

error

required

Human-readable error summary.

string

code

required

HTTP-status-level class. Stable enum; branch on details.reason for finer control. Current values: invalid_query, invalid_slug, invalid_license_id, invalid_jurisdiction_code, invalid_pagination, not_found, auth_required, auth_invalid, auth_revoked, payment_required, quota_exceeded, rate_limited, server_error.

string

details

required

object

reason

required

Machine-readable refinement of the top-level code. Stable vocabulary; branch on this in clients. Examples: invalid_input, missing_required_parameter, conflicting_parameters, operator_not_found, license_not_found, jurisdiction_not_found, route_not_found, api_key_missing, malformed_header, api_key_invalid, api_key_revoked, quota_exceeded, internal_error.

string

field

Present only when the error maps to a specific request input field (query param, path param, body key). Omitted for errors that aren’t field-scoped (e.g. rate_limited, auth_revoked).

string

suggestion

Optional human-readable / agent-actionable hint describing how to resolve the error.

string

{
  "reason": "api_key_revoked",
  "suggestion": "Generate a new API key at https://app.igregulator.io/settings. Revoked keys cannot be restored."
}

{
  "error": "API key has been revoked",
  "code": "auth_revoked",
  "details": {
    "reason": "api_key_revoked",
    "suggestion": "Generate a new API key at https://app.igregulator.io/settings. Revoked keys cannot be restored."
  }
}

500

Unexpected server error.

object

error

required

Human-readable error summary.

string

code

required

HTTP-status-level class. Stable enum; branch on details.reason for finer control. Current values: invalid_query, invalid_slug, invalid_license_id, invalid_jurisdiction_code, invalid_pagination, not_found, auth_required, auth_invalid, auth_revoked, payment_required, quota_exceeded, rate_limited, server_error.

string

details

required

object

reason

required

Machine-readable refinement of the top-level code. Stable vocabulary; branch on this in clients. Examples: invalid_input, missing_required_parameter, conflicting_parameters, operator_not_found, license_not_found, jurisdiction_not_found, route_not_found, api_key_missing, malformed_header, api_key_invalid, api_key_revoked, quota_exceeded, internal_error.

string

field

Present only when the error maps to a specific request input field (query param, path param, body key). Omitted for errors that aren’t field-scoped (e.g. rate_limited, auth_revoked).

string

suggestion

Optional human-readable / agent-actionable hint describing how to resolve the error.

string

{
  "reason": "api_key_revoked",
  "suggestion": "Generate a new API key at https://app.igregulator.io/settings. Revoked keys cannot be restored."
}

{
  "error": "API key has been revoked",
  "code": "auth_revoked",
  "details": {
    "reason": "api_key_revoked",
    "suggestion": "Generate a new API key at https://app.igregulator.io/settings. Revoked keys cannot be restored."
  }
}

Operator detail — metadata + licences + domains

Authorizations

Parameters

Path Parameters

Query Parameters

Example

Responses

200

401

404

500