Per-country schema reference and tool-support matrix
list_jurisdictionsRetrieve per-country reference data dictionary for jurisdictions. Pass a country code to get full schema including registry info, company ID format, status mappings, and supported tools. Pass a tool name to see which jurisdictions implement it.
Instructions
Per-country reference data dictionary. Two modes — pass EXACTLY ONE of:
• jurisdiction: 'GB' — full schema for one country: registry name + URL, data license, company ID format with examples, native status values + mapping to the unified active/inactive/dissolved/unknown enum, list of supported tools, list of field names available in jurisdiction_data sub-objects (profile/filing/officer/shareholder/psc/charge), free-text quirks notes, and the global_search_excluded flag.
• supports_tool: 'get_officers' — cross-country matrix for one tool: which jurisdictions implement it (with their registry names) and which don't.
Calling with no parameters returns a structured 400 with both shapes documented. For server-level info (codes list, version, rate limits) call about instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jurisdiction | No | ISO 3166-1 alpha-2 country code (case-insensitive; CA subdivisions hyphenated like 'CA-BC'). Returns the full per-country schema. Mutually exclusive with `supports_tool`. | |
| supports_tool | No | Tool name (e.g. 'get_officers', 'get_persons_with_significant_control'). Returns the matrix of which jurisdictions implement this tool. Mutually exclusive with `jurisdiction`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| queried_at | Yes | ISO-8601 + Europe/London timezone stamp for when the registry was queried. | |
| jurisdiction | No | Populated in single-country mode: carries the JurisdictionMetadata for the requested country. | |
| tool | No | Populated in cross-country support-matrix mode: echoes the tool name that was queried. | |
| supported_count | No | ||
| supported_in | No | ||
| not_supported_count | No | ||
| not_supported_in | No | ||
| hint | No |