{"openapi":"3.0.0","paths":{"/v2/pricing":{"get":{"description":"Returns pricing for a specific country.\n\nThe response includes:\n- blocks: SKUs, datapoint coverage, verification and prefill mode prices (with an authoritative hint), and optional includedDocuments\n- Flat fields: per-datapoint availability and prices (legacy companyProfile included)\n- Company search and availableDocuments listing are free\n\nPrices are in credits (account balance units). Rates may vary by subscription plan.","operationId":"PricingController_getPricing_v2","parameters":[{"name":"countryCode","required":true,"in":"query","description":"The country code in ISO 3166-1 alpha-2 format (e.g., \"FR\" for France, \"DE\" for Germany).","schema":{"example":"FR","type":"string","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"]}}],"responses":{"200":{"description":"Pricing information retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPricingResultDTO"}}}}},"security":[{"x-api-key":[]}],"summary":"Get pricing for a country","tags":["Pricing"]}},"/v2/monitors":{"post":{"operationId":"MonitoringController_createMonitor_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMonitorDto"}}}},"responses":{"201":{"description":"Monitor created or retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMonitorResponseDto"}}}},"400":{"description":"Invalid request or monitoring not supported for country"},"401":{"description":"Invalid or missing API key"}},"security":[{"x-api-key":[]}],"summary":"Add monitoring for a company","tags":["Monitors"]},"get":{"operationId":"MonitoringController_listMonitors_v2","parameters":[{"name":"companyId","required":false,"in":"query","description":"Filter by company ID","schema":{"example":"123456789","type":"string"}},{"name":"countryCode","required":false,"in":"query","description":"Filter by country code (ISO 2-letter)","schema":{"example":"DE","type":"string","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"]}},{"name":"after","required":false,"in":"query","description":"Cursor for pagination","schema":{"example":"cmfzlu1dt000j12ldeqrfszq0","type":"string"}},{"name":"first","required":false,"in":"query","description":"Number of items to fetch (default: 50)","schema":{"minimum":1,"example":25,"type":"number"}}],"responses":{"200":{"description":"List of monitors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMonitorsResponseDto"}}}},"401":{"description":"Invalid or missing API key"}},"security":[{"x-api-key":[]}],"summary":"List monitored companies","tags":["Monitors"]}},"/v2/monitors/{id}":{"get":{"operationId":"MonitoringController_getMonitor_v2","parameters":[{"name":"id","required":true,"in":"path","description":"Monitor ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Monitor details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDetailsResponseDto"}}}},"401":{"description":"Invalid or missing API key"},"404":{"description":"Monitor not found or access denied"}},"security":[{"x-api-key":[]}],"summary":"Get monitor details","tags":["Monitors"]},"delete":{"operationId":"MonitoringController_stopMonitoring_v2","parameters":[{"name":"id","required":true,"in":"path","description":"Monitor ID to stop","schema":{"type":"string"}}],"responses":{"204":{"description":"Monitor deleted successfully"},"401":{"description":"Invalid or missing API key"},"404":{"description":"Monitor not found or access denied"}},"security":[{"x-api-key":[]}],"summary":"Stop monitoring a company","tags":["Monitors"]}},"/v2/monitors/{id}/logs":{"get":{"operationId":"MonitoringController_getMonitorLogs_v2","parameters":[{"name":"id","required":true,"in":"path","description":"Monitor ID","schema":{"type":"string"}},{"name":"first","required":false,"in":"query","description":"Number of items to fetch (default: 25)","schema":{"type":"number"}},{"name":"after","required":false,"in":"query","description":"Cursor for pagination","schema":{"type":"string"}}],"responses":{"200":{"description":"Monitor change logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorLogsResponseDto"}}}},"401":{"description":"Invalid or missing API key"},"404":{"description":"Monitor not found or access denied"}},"security":[{"x-api-key":[]}],"summary":"Get monitor change logs","tags":["Monitors"]}},"/v2/monitors/{id}/test-notification":{"post":{"description":"Delivers a real `monitor.notification` event for this monitor to your configured webhook endpoint. Unlike the static sample in the webhooks portal, the payload is built exactly as a genuine change notification is: your own monitor id, your own metadata, the real company. The monitor itself is not modified and the next scheduled check is unaffected.","operationId":"MonitoringController_sendTestNotification_v2","parameters":[{"name":"id","required":true,"in":"path","description":"Monitor ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestNotificationDto"}}}},"responses":{"200":{"description":"Notification delivered; returns the exact payload sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestNotificationResponseDto"}}}},"400":{"description":"No webhook endpoint configured, or invalid change categories"},"401":{"description":"Invalid or missing API key"},"404":{"description":"Monitor not found or access denied"}},"security":[{"x-api-key":[]}],"summary":"Send a test notification for a monitor","tags":["Monitors"]}},"/v2/search-monitors":{"post":{"description":"Opt-in beta. Watches a company name and optional address constraints without a registration number. Checks hourly, subject to register publication and search availability. Existing matches form the baseline; new matching IDs trigger search_monitor.match webhooks. Reposting the same query retrieves its subscription. No company data or documents are purchased.","operationId":"SearchMonitoringController_create_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSearchMonitorDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSearchMonitorResponseDto"}}}},"400":{"description":"Invalid, overly broad query, expiry, or beta capacity reached."},"403":{"description":"Search monitoring is not enabled for this account."}},"security":[{"x-api-key":[]}],"summary":"Watch for newly matching French companies","tags":["Search monitors"]},"get":{"operationId":"SearchMonitoringController_list_v2","parameters":[{"name":"after","required":false,"in":"query","description":"Cursor returned by the previous page; page size is 50.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSearchMonitorsResponseDto"}}}}},"security":[{"x-api-key":[]}],"summary":"List search monitors","tags":["Search monitors"]}},"/v2/search-monitors/{id}":{"get":{"operationId":"SearchMonitoringController_get_v2","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchMonitorDto"}}}},"404":{"description":"Search monitor not found."}},"security":[{"x-api-key":[]}],"summary":"Get a search monitor","tags":["Search monitors"]},"delete":{"description":"Stops future notification dispatch. Events already accepted by the webhook service may still be delivered.","operationId":"SearchMonitoringController_stop_v2","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"204":{"description":""},"404":{"description":"Search monitor not found."}},"security":[{"x-api-key":[]}],"summary":"Stop a search monitor","tags":["Search monitors"]}},"/v2/search":{"get":{"description":"This endpoint allows you to search for companies based on a country code and a query string.\n\nThe search can be performed using either a company legal name, commercial name, historical name, or registration number. Capabilities vary by country. A Legal Entity Identifier (LEI) is accepted as the query in every country and returns the company it designates.\n\n**Standard Mode (stream=false or omitted):**\nReturns JSON array of results once all search sources have completed.\n\n**Streaming Mode (stream=true):**\nReturns Server-Sent Events (SSE) with progressive results as each search source completes. The endpoint emits named events:\n- `progress`: Partial results from completed sources\n- `complete`: Final results when all sources finish\n- `error`: If the search fails\n\nStreaming is beneficial for countries with multiple search sources (e.g., Germany queries both Unternehmensregister and Handelsregister), providing faster time-to-first-result.\n\nResponse times vary by country: from sub-second to up to 10 seconds.","operationId":"SearchController_searchV2_v2","parameters":[{"name":"country","required":true,"in":"query","description":"The country code in ISO 3166-1 alpha-2 format (e.g., \"FR\" for France, \"DE\" for Germany).","schema":{"example":"FR","type":"string","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"]}},{"name":"query","required":true,"in":"query","description":"The search query, which can be a company name, a registration number or an LEI. Note that search capabilities may vary by country, with some supporting only name or registration number searches. An LEI (Legal Entity Identifier, 20 characters) is recognised in every country: it returns the company the LEI designates, under its registration number, or nothing. The LEI decides where that company is registered, so the result can carry another `countryCode` than the `country` requested.","schema":{"example":"Topograph","type":"string"}},{"name":"stream","required":false,"in":"query","description":"Enable streaming mode. When true, returns Server-Sent Events (SSE) with progressive results as each search source completes. Set Accept header to \"text/event-stream\" for proper streaming. When false or omitted, returns standard JSON array after all sources complete.","schema":{"example":true,"type":"boolean"}},{"name":"activeOnly","required":false,"in":"query","description":"When true, only companies the register reports as active are returned: dissolved, struck-off, deregistered and otherwise inactive companies are excluded. A company whose status the search source does not report is kept rather than hidden. Whether a country's search can return inactive companies at all, and how completely this filter applies there, is published per country in the catalog under `search`. When false or omitted, results are not filtered on status.","schema":{"example":true,"type":"boolean"}},{"name":"strictActiveOnly","required":false,"in":"query","description":"When true, returns only results explicitly reported as active and excludes unknown statuses. Implies activeOnly. Status freshness depends on the search source; this does not request a new company verification.","schema":{"example":false,"type":"boolean"}},{"name":"transliterate","required":false,"in":"query","description":"When true, user-facing string fields in the response (company names, addresses, person names, activity descriptions) are romanized from their native script to Latin characters on the way out. Internal data, cache, and billing are unaffected — only the response payload is transformed. Routing: Cyrillic/Greek/Hangul/Hebrew/Arabic/Thai via unidecode, Chinese via pinyin-pro (toneless), Japanese via kuroshiro (Hepburn).","schema":{"example":false,"type":"boolean"}}],"responses":{"200":{"description":"List of companies (JSON when stream=false, SSE when stream=true)","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"}}},"text/event-stream":{"schema":{"type":"string","description":"Server-Sent Events stream with named events:\n- `progress`: Partial results as sources complete\n- `complete`: Final results when all sources finish\n- `error`: Error occurred","example":"event: progress\ndata: {\"results\":[{\"id\":\"123\",\"legalName\":\"Company A\",\"countryCode\":\"DE\",\"address\":{...}}]}\n\nevent: complete\ndata: {\"results\":[{\"id\":\"123\",\"legalName\":\"Company A\",...},{\"id\":\"456\",\"legalName\":\"Company B\",...}]}"}}}},"400":{"description":"Bad Request - Invalid search query","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":400},"error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/PublicErrorCode"}],"example":"invalid_request"},"message":{"type":"string","example":"Query is too short. Please provide at least 2 characters for company name search"},"details":{"type":"array","items":{"type":"string"},"example":["Query must be at least 2 characters"]}}}}}}}},"500":{"description":"Internal Server Error - Search failed","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":500},"error":{"type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/PublicErrorCode"}],"example":"service_unavailable"},"message":{"type":"string","example":"An error occurred while searching. Please try again later."}}}}}}}}},"security":[{"x-api-key":[]}],"summary":"Search for companies","tags":["Search"]}},"/v2/search/global":{"post":{"description":"Takes what you know about a company in one free-text `query` (the name plus a city, a country, a registration number, a website…) and returns candidates across the countries Topograph covers, best first, each with a registration number you can pass to `/v2/company`, a match strength and an explanation of the evidence.\n\nThe search is agentic and bounded: it reads the legal form and any address, checks Topograph's index, asks the web when the name and that data are not enough, confirms in the most likely registers (US states included), and stops as soon as one candidate is a strong match. At most 15 live and web searches, at most 100 seconds.\n\n**Countries.** `countries` limits the search to some countries: `[\"US\"]` searches every US state and nothing else, `[\"US-DE\", \"US-NY\"]` two states, `[\"CA\"]` every Canadian jurisdiction (the federal register `CA-FED` and the provinces and territories, `CA-ON`, `CA-QC`…), `[\"DE\", \"AT\", \"CH\"]` three countries. Nothing outside them is searched or returned.\n\n**Status.** `resolved`: one strong match, the candidate with `selected: true`, which you can use without a person checking. `ambiguous`: several plausible candidates (the same name in two countries, two namesakes in one register, a US company whose state is not established), all returned with their evidence. `not_found`: nothing acceptable; `reason` says why, and `likelyCountryCode` names the country the evidence pointed to even when Topograph does not cover it or it is outside `countries`.\n\n**Company status.** A candidate's `isActive` is indicative only and may be out of date; read `company.status` from `/v2/company` before relying on it.\n\n**Alpha.** The request and response shapes may still change.\n\n**Billing.** A search is billed only when it succeeds: `status: resolved`, one good candidate. Ambiguous and not-found searches, inputs rejected as not a legal entity, failures and timeouts are not billed. `usage.priceCents` shows what was charged; the price is on the pricing page.\n\n**Streaming.** With `stream: true` and `Accept: text/event-stream`, the endpoint emits `progress` events (what the search is doing right now, and the candidates found so far), then one `complete` event with the final response, or an `error` event.","operationId":"GlobalSearchController_globalSearch_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSearchRequestDto"}}}},"responses":{"200":{"description":"The candidates and their explanations (JSON), or the SSE stream when `stream` is true.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSearchResponse"}},"text/event-stream":{"schema":{"type":"string","description":"Named events: `progress` (GlobalSearchProgress), `complete` (GlobalSearchResponse), `error`.","example":"event: progress\ndata: {\"isComplete\":false,\"revision\":3,\"activity\":[\"Asking the register in Austria\"],\"candidates\":[]}\n\nevent: complete\ndata: {\"id\":\"global-search-…\",\"status\":\"resolved\",...}"}}}},"400":{"description":"Invalid request (empty query, empty `countries`, or a code in `countries` that is not a country).","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":400},"error":{"type":"object","properties":{"code":{"type":"string","example":"invalid_request"},"message":{"type":"string","example":"query cannot be empty"}}}}}}}},"402":{"description":"Not enough credits for a run.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":402},"error":{"type":"object","properties":{"code":{"type":"string","example":"insufficient_funds"},"message":{"type":"string","example":"Not enough credits for a global search."}}}}}}}},"429":{"description":"Fair-use limit: too many runs this minute, or too many running at once, for this account.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":429},"error":{"type":"object","properties":{"code":{"type":"string","example":"rate_limited"},"message":{"type":"string","example":"Too many global searches this minute for this account. Retry shortly."}}}}}}}},"503":{"description":"The run exceeded its time limit.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":503},"error":{"type":"object","properties":{"code":{"type":"string","example":"search_timeout"},"message":{"type":"string","example":"The global search took too long to complete."}}}}}}}}},"security":[{"x-api-key":[]}],"summary":"Find a company across countries from its name","tags":["Search"]}},"/v2/workspaces/{name}/vault":{"get":{"operationId":"VaultController_list_v2","parameters":[{"name":"name","required":true,"in":"path","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"default"}}],"responses":{"200":{"description":"Vault entry metadata. Never contains plaintext.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VaultEntryView"}}}}}},"summary":"List vault entries on the workspace (metadata only)","tags":["Vault"]}},"/v2/workspaces/{name}/vault/{sourceKey}":{"get":{"operationId":"VaultController_getOne_v2","parameters":[{"name":"sourceKey","required":true,"in":"path","description":"Source key (see GET /v2/vault/sources)","schema":{"example":"de_transparenzregister","type":"string"}},{"name":"name","required":true,"in":"path","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"default"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultEntryView"}}}},"404":{"description":"No entry stored for this (workspace, sourceKey)."}},"summary":"Get one vault entry by sourceKey (metadata only)","tags":["Vault"]},"put":{"description":"Payload shape depends on the sourceKey's format. Hit `GET /v2/vault/sources` for the list of accepted fields. Each PUT bumps the entry version.","operationId":"VaultController_upsert_v2","parameters":[{"name":"sourceKey","required":true,"in":"path","schema":{"example":"de_transparenzregister","type":"string"}},{"name":"name","required":true,"in":"path","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"default"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutVaultEntryDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VaultEntryView"}}}}},"summary":"Create or replace a credential","tags":["Vault"]},"delete":{"operationId":"VaultController_remove_v2","parameters":[{"name":"sourceKey","required":true,"in":"path","schema":{"example":"de_transparenzregister","type":"string"}},{"name":"name","required":true,"in":"path","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"default"}}],"responses":{"204":{"description":"Entry deleted."},"404":{"description":"No entry stored for this (workspace, sourceKey)."}},"summary":"Delete a credential","tags":["Vault"]}},"/v2/vault/sources":{"get":{"description":"Returns every sourceKey accepted by `PUT /v2/workspaces/:name/vault/:sourceKey`, with the required payload fields and their `secret` flags.","operationId":"VaultSourcesController_list_v2","parameters":[],"responses":{"200":{"description":"List of supported sources and their PUT payload shapes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","example":"de_transparenzregister"},"format":{"type":"string","example":"email_password"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["string","array"]},"required":{"type":"boolean"},"secret":{"type":"boolean"},"item":{"type":"object","nullable":true,"description":"For `type: \"array\"` fields — the schema of each repeated item (e.g. a `{username, password}` account in a credential pool).","properties":{"fields":{"type":"array","items":{"type":"object"}}}}}}}}}}}}}},"summary":"List supported credential sources","tags":["Vault"]}},"/v2/discrepancy-reports":{"post":{"description":"**Beta.** Germany only for now; more countries are coming. The request and response shapes may change. Available on accounts with access to the beta; contact support@topograph.co to request it.\n\nReports a discrepancy between a beneficial-ownership register and the beneficial owners you identified, filed immediately under your own register account. Send the owners in the same shape as `ultimateBeneficialOwners` in the company response; the exact text filed is returned in `filing.text`. The filing completes asynchronously: poll `GET /v2/discrepancy-reports/{id}` or listen for the `discrepancy_report.updated` webhook.","operationId":"DiscrepancyReportsController_create_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Workspace whose register credentials file the report. Defaults to the default workspace.","required":false,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Unique key for this report (a UUID is recommended). Resending the same body with the same key returns the original report (200) and files nothing new; a different body with a used key is refused (409).","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDiscrepancyReportDto"}}}},"responses":{"200":{"description":"Replay of an earlier request with the same Idempotency-Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscrepancyReportDto"}}}},"201":{"description":"Report accepted and being filed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscrepancyReportDto"}}}},"400":{"description":"`invalid_request`: missing Idempotency-Key, unsupported country, reason or evidence, or explanation too long","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"invalid_request"},"message":{"type":"string","example":"Discrepancy reports are not available for FR yet. Supported: DE."},"retryable":{"type":"boolean","example":false}}}}}}}},"403":{"description":"`feature_not_enabled`: the beta is not enabled on this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"feature_not_enabled"},"message":{"type":"string","example":"Discrepancy reports are in beta and not enabled on this account."},"retryable":{"type":"boolean","example":false}}}}}}}},"409":{"description":"`invalid_request`: the Idempotency-Key was already used for a different body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"invalid_request"},"message":{"type":"string","example":"This Idempotency-Key was already used for a different report."},"retryable":{"type":"boolean","example":false}}}}}}}},"428":{"description":"`account_configuration_required`: no register credentials stored for this workspace","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"account_configuration_required"},"message":{"type":"string","example":"Reports are filed under your own Transparenzregister account."},"retryable":{"type":"boolean","example":false}}}}}}}},"429":{"description":"`quota_exceeded`: the subscription's monthly allowance is used up","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"quota_exceeded"},"message":{"type":"string","example":"Your subscription allows 50 discrepancy reports per period, and they are used up."},"retryable":{"type":"boolean","example":false}}}}}}}}},"security":[{"x-api-key":[]}],"summary":"File a discrepancy report (Beta)","tags":["Discrepancy reports (Beta)"],"x-beta":true},"get":{"description":"**Beta.** Germany only for now; more countries are coming. The request and response shapes may change. Available on accounts with access to the beta; contact support@topograph.co to request it.\n\nYour reports, newest first.","operationId":"DiscrepancyReportsController_list_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Workspace whose register credentials file the report. Defaults to the default workspace.","required":false,"schema":{"type":"string"}},{"name":"companyId","required":false,"in":"query","description":"Filter by company ID","schema":{"example":"München HRB 228960","type":"string"}},{"name":"countryCode","required":false,"in":"query","description":"Filter by country code (ISO 2-letter)","schema":{"example":"DE","type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by status","schema":{"$ref":"#/components/schemas/DiscrepancyReportStatus"}},{"name":"after","required":false,"in":"query","description":"Cursor for pagination (`nextCursor` of the previous page)","schema":{"type":"string"}},{"name":"first","required":false,"in":"query","description":"Number of items to fetch (default: 50, max: 100)","schema":{"minimum":1,"maximum":100,"example":25,"type":"number"}}],"responses":{"200":{"description":"A page of reports","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDiscrepancyReportsResponseDto"}}}},"403":{"description":"`feature_not_enabled`: the beta is not enabled on this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"feature_not_enabled"},"message":{"type":"string","example":"Discrepancy reports are in beta and not enabled on this account."},"retryable":{"type":"boolean","example":false}}}}}}}}},"security":[{"x-api-key":[]}],"summary":"List discrepancy reports (Beta)","tags":["Discrepancy reports (Beta)"],"x-beta":true}},"/v2/discrepancy-reports/usage":{"get":{"description":"**Beta.** Germany only for now; more countries are coming. The request and response shapes may change. Available on accounts with access to the beta; contact support@topograph.co to request it.\n\nReports counted in the current period against your subscription allowance.","operationId":"DiscrepancyReportsController_usage_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Workspace whose register credentials file the report. Defaults to the default workspace.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Usage in the current period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscrepancyReportUsageDto"}}}},"403":{"description":"`feature_not_enabled`: the beta is not enabled on this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"feature_not_enabled"},"message":{"type":"string","example":"Discrepancy reports are in beta and not enabled on this account."},"retryable":{"type":"boolean","example":false}}}}}}}}},"security":[{"x-api-key":[]}],"summary":"Get discrepancy report usage (Beta)","tags":["Discrepancy reports (Beta)"],"x-beta":true}},"/v2/discrepancy-reports/{id}":{"get":{"description":"**Beta.** Germany only for now; more countries are coming. The request and response shapes may change. Available on accounts with access to the beta; contact support@topograph.co to request it.\n\nThe current state of a report: poll it until `status` is `succeeded` or `failed`. Free.","operationId":"DiscrepancyReportsController_get_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Workspace whose register credentials file the report. Defaults to the default workspace.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","description":"The report id returned when the report was filed","schema":{"type":"string"}}],"responses":{"200":{"description":"The report","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscrepancyReportDto"}}}},"403":{"description":"`feature_not_enabled`: the beta is not enabled on this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"feature_not_enabled"},"message":{"type":"string","example":"Discrepancy reports are in beta and not enabled on this account."},"retryable":{"type":"boolean","example":false}}}}}}}},"404":{"description":"`resource_not_found`: no such report on this account","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"resource_not_found"},"message":{"type":"string","example":"Discrepancy report not found."},"retryable":{"type":"boolean","example":false}}}}}}}}},"security":[{"x-api-key":[]}],"summary":"Get a discrepancy report (Beta)","tags":["Discrepancy reports (Beta)"],"x-beta":true}},"/v2/company":{"post":{"description":"Retrieve company data and documents for a specific company.\n\nYou can either:\n1. Create a new request by providing countryCode, id, dataPoints, optional mode, and optional document IDs.\n2. Re-fetch a previous request by providing requestId (returns cached data and is not billed again).\n\nAvailable datapoints include:\n- company: core company information\n- legalRepresentatives: directors, managers, and signing officers\n- otherKeyPersons: auditors, board members, and similar roles when available\n- establishments: branches and secondary locations when available\n- shareholders: shareholder structure\n- subsidiaries: downstream equity holdings when available\n- ultimateBeneficialOwners: beneficial owner information\n- availableDocuments: list of available official documents\n- graph: ownership graph traversal (verification mode only)\n\nLegacy companyProfile is deprecated and accepted only before December 1, 2026 at 00:00 UTC. From that instant, new requests containing it return HTTP 400. Request company, legalRepresentatives, otherKeyPersons and establishments explicitly as needed. Existing request results remain retrievable.\n\nModes:\n- verification (default): authoritative live registry sources. Countries served only by a non-authoritative source are prefill-only, and fail here with authoritative_source_unavailable.\n- prefill: cheapest compatible fast source; unsupported datapoints fail with fast_source_unavailable. The graph datapoint has no fast source and always fails this way in prefill mode.\n\nTo retrieve documents, first request availableDocuments to discover document IDs, then pass those IDs in the documents field of a follow-up request.","operationId":"CompanyController_getCompany_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Selects the workspace for this request: usage is attributed to it, and register credentials resolve from it. Takes the workspace `name` (the value you sent to `POST /v2/workspaces`), not the UUID `id` returned on creation. Omit to use the account's `default` workspace. Unknown name returns 404; a name outside `^[a-zA-Z0-9_:-]+$` or over 64 characters returns 400.","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_:-]+$","maxLength":64,"example":"acme-paris"}},{"name":"transliterate","required":false,"in":"query","description":"If true, transliterates non-Latin strings in the response to Latin script.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateCompanyRequestDTO"},{"$ref":"#/components/schemas/GetCompanyRequestResultDTO"}]}}}},"responses":{"200":{"description":"Result of an existing request, returned when the body carries a `requestId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyResultDTO"}}}},"201":{"description":"Company request created. Poll for the result with `requestId`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyResultDTO"}}}},"400":{"description":"Invalid request, including new requests containing companyProfile on or after December 1, 2026 at 00:00 UTC."}},"security":[{"x-api-key":[]}],"summary":"Get Company Data and Documents","tags":["Data"]}},"/v2/company/{requestId}":{"get":{"description":"Retrieve the result of a previous company data request by its ID. Returns the latest available data including all subrequests (documents, additional datapoints).\n\nThis endpoint is free and will not be billed again. Use it to poll for results after creating a request via POST /v2/company.","operationId":"CompanyController_getCompanyRequest_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Selects the workspace for this request: usage is attributed to it, and register credentials resolve from it. Takes the workspace `name` (the value you sent to `POST /v2/workspaces`), not the UUID `id` returned on creation. Omit to use the account's `default` workspace. Unknown name returns 404; a name outside `^[a-zA-Z0-9_:-]+$` or over 64 characters returns 400.","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_:-]+$","maxLength":64,"example":"acme-paris"}},{"name":"requestId","required":true,"in":"path","description":"The request ID returned by the initial POST /v2/company call","schema":{"example":"253299d1-e8d0-4268-945b-f175f98bc114","type":"string"}},{"name":"transliterate","required":false,"in":"query","description":"If true, transliterates non-Latin strings in the response to Latin script.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Company request result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyResultDTO"}}}},"404":{"description":"Request not found or does not belong to this account"}},"security":[{"x-api-key":[]}],"summary":"Get Company Request Result","tags":["Data"]}},"/v2/company/{requestId}/pdf":{"get":{"description":"Render the result of a company data request as a one-file PDF extract: company profile, legal representatives, shareholders, ultimate beneficial owners, other key persons, establishments and the ownership graph, whichever of those the request asked for and received.\n\nThis endpoint is free and is never billed. It renders data the request already paid for, so a PDF can be re-downloaded as often as needed and never triggers a new fetch.\n\nCompleteness: by default the extract renders whatever has arrived, matching `GET /v2/company/{requestId}`, which also returns partial results while a request runs. A partial extract says so on its own face: a \"Data completeness\" section at the end of the extract lists every requested datapoint and whether it was included, is still being retrieved, or failed, and the `X-Topograph-Data-Status` response header carries `complete` or `partial`. Pass `requireComplete=true` to get a 409 instead of a partial file, for an archival export that must not be a snapshot of a half-finished request.\n\nOnly datapoints decide completeness. Documents are delivered as separate files and never appear in the extract, so a document still downloading does not hold the PDF back.","operationId":"CompanyController_getCompanyRequestPdf_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Selects the workspace for this request: usage is attributed to it, and register credentials resolve from it. Takes the workspace `name` (the value you sent to `POST /v2/workspaces`), not the UUID `id` returned on creation. Omit to use the account's `default` workspace. Unknown name returns 404; a name outside `^[a-zA-Z0-9_:-]+$` or over 64 characters returns 400.","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_:-]+$","maxLength":64,"example":"acme-paris"}},{"name":"requestId","required":true,"in":"path","description":"The request ID returned by the initial POST /v2/company call","schema":{"example":"253299d1-e8d0-4268-945b-f175f98bc114","type":"string"}},{"name":"requireComplete","required":false,"in":"query","description":"If true, respond 409 rather than render an extract while any requested datapoint is still in progress. Accepts true/false/1/0; any other value is rejected with 400. Defaults to false.","schema":{"type":"boolean"}},{"name":"disposition","required":false,"in":"query","description":"Controls `Content-Disposition`. `attachment` (default) prompts a download; `inline` lets a browser or viewer render the PDF in place.","schema":{"enum":["attachment","inline"],"type":"string"}}],"responses":{"200":{"description":"The PDF extract. `X-Topograph-Data-Status` is `complete` when every requested datapoint reached a terminal state, `partial` otherwise.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"A query parameter could not be parsed, e.g. `requireComplete=yes`."},"404":{"description":"Request not found or does not belong to this account"},"409":{"description":"The request cannot be rendered in its current state. Body carries `code` — `extract_data_incomplete` (the request is still running: either `requireComplete=true` was passed, or no company data has arrived yet; `pendingDataPoints` lists what it is waiting on) or `extract_no_data` (the request settled without any company data)."}},"security":[{"x-api-key":[]}],"summary":"Download Company Extract as PDF","tags":["Data"]}},"/v2/onboarding":{"post":{"deprecated":true,"description":"Deprecated: Use POST /v2/company with mode: \"prefill\" instead.\n\nThis endpoint is internally routed as a company request with mode: \"prefill\" and a 50-cent budget cap. The result status is reported under dataStatus.dataPoints.company.","operationId":"CompanyOnboardingController_getOnboarding_v2","parameters":[{"name":"x-topograph-workspace-id","in":"header","description":"Selects the workspace for this request: usage is attributed to it, and register credentials resolve from it. Takes the workspace `name` (the value you sent to `POST /v2/workspaces`), not the UUID `id` returned on creation. Omit to use the account's `default` workspace. Unknown name returns 404; a name outside `^[a-zA-Z0-9_:-]+$` or over 64 characters returns 400.","required":false,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_:-]+$","maxLength":64,"example":"acme-paris"}},{"name":"transliterate","required":false,"in":"query","description":"If true, transliterates non-Latin strings in the response to Latin script.","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CreateOnboardingRequestDTO"},{"$ref":"#/components/schemas/GetCompanyRequestResultDTO"}]}}}},"responses":{"201":{"description":"Company onboarding information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyResultDTO"}}}}},"security":[{"x-api-key":[]}],"summary":"Get Onboarding Data (Deprecated)","tags":["Data"]}},"/v2/workspaces":{"get":{"operationId":"WorkspaceController_listWorkspaces_v2","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"List all workspaces","tags":["Workspaces"]},"post":{"operationId":"WorkspaceController_createWorkspace_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspaceDto"}}}},"responses":{"201":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Create a new workspace","tags":["Workspaces"]}},"/v2/workspaces/{name}":{"patch":{"operationId":"WorkspaceController_updateWorkspace_v2","parameters":[{"name":"name","required":true,"in":"path","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"acme-paris","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceDto"}}}},"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Update a workspace","tags":["Workspaces"]},"delete":{"operationId":"WorkspaceController_deleteWorkspace_v2","parameters":[{"name":"name","required":true,"in":"path","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"acme-paris","type":"string"}}],"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Delete a workspace","tags":["Workspaces"]}},"/v2/workspaces/usage":{"get":{"operationId":"WorkspaceController_getUsageReport_v2","parameters":[{"name":"startDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"endDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"workspace","required":false,"in":"query","description":"Workspace `name` (not the UUID `id` returned on creation)","schema":{"example":"acme-paris","type":"string"}}],"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Get usage report per workspace","tags":["Workspaces"]}},"/v2/environments":{"get":{"description":"Returns the live environment followed by every development environment, each with its API key.","operationId":"DevelopmentAccountsController_list_v2","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"List environments","tags":["Environments"]},"post":{"description":"Development environments return generated data for every supported country and never consume credits.","operationId":"DevelopmentAccountsController_create_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDevelopmentAccountDto"}}}},"responses":{"201":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Create a development environment","tags":["Environments"]}},"/v2/environments/{name}/settings":{"post":{"operationId":"DevelopmentAccountsController_update_v2","parameters":[{"name":"name","required":true,"in":"path","schema":{"example":"sandbox","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDevelopmentAccountDto"}}}},"responses":{"201":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Update a development environment","tags":["Environments"]}},"/v2/environments/{name}/rotate-key":{"post":{"description":"The previous key stops working immediately.","operationId":"DevelopmentAccountsController_rotateKey_v2","parameters":[{"name":"name","required":true,"in":"path","schema":{"example":"sandbox","type":"string"}}],"responses":{"201":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Rotate a development environment API key","tags":["Environments"]}},"/v2/environments/{name}":{"delete":{"operationId":"DevelopmentAccountsController_remove_v2","parameters":[{"name":"name","required":true,"in":"path","schema":{"example":"sandbox","type":"string"}}],"responses":{"204":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Delete a development environment","tags":["Environments"]}},"/v2/sandbox/wallet":{"get":{"operationId":"SandboxWalletController_read_v2","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Read the sandbox wallet","tags":["Sandbox"]},"put":{"description":"Sets the virtual balance to an exact figure and optionally disables the automatic refill, so credit depletion and insufficient_funds behaviour can be tested end to end. Development environments only.","operationId":"SandboxWalletController_set_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetSandboxWalletDto"}}}},"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Set the sandbox wallet balance","tags":["Sandbox"]}},"/v2/sandbox/monitor-webhook":{"post":{"description":"Delivers a real monitor event for one of your monitors to your configured webhook endpoint: `monitor.notification` (optionally reporting the monitor as deactivated, as a `disappeared` change does) or the credential-gate transitions `monitor.datapoint_blocked` / `monitor.datapoint_unblocked`. The payload is built exactly as the daily monitoring workflow builds it. Development environments only.","operationId":"SandboxMonitorController_trigger_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerMonitorWebhookDto"}}}},"responses":{"200":{"description":"Event delivered; returns the exact payload sent"},"400":{"description":"No webhook endpoint configured for this environment"},"404":{"description":"Monitor not found or access denied"}},"security":[{"x-api-key":[]}],"summary":"Trigger a monitor webhook","tags":["Sandbox"]}},"/v2/sandbox/reset":{"post":{"description":"Deletes this environment’s request history, search logs and webhook logs, and restores the virtual wallet. The environment itself is untouched: same API key, same webhook endpoints, same settings. Refuses with 409 while a request is still in progress. Development environments only.","operationId":"SandboxResetController_reset_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetSandboxDto"}}}},"responses":{"200":{"description":"Reset done; returns what was removed"},"409":{"description":"A request is still in progress — wait for it or cancel it first"}},"security":[{"x-api-key":[]}],"summary":"Reset a development environment","tags":["Sandbox"]}},"/v2/sandbox/companies":{"post":{"description":"Stores a company this environment returns for a given identifier. Send as much or as little of it as you care about: anything omitted is still generated. Returns the identifier to use in /v2/company and /v2/search.","operationId":"SandboxFixturesController_create_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSandboxFixtureDto"}}}},"responses":{"201":{"description":"Fixture stored; returns the identifier to request it by"}},"security":[{"x-api-key":[]}],"summary":"Define a company","tags":["Sandbox"]},"get":{"operationId":"SandboxFixturesController_list_v2","parameters":[],"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"List the companies you defined","tags":["Sandbox"]}},"/v2/sandbox/companies/{countryCode}/{identifier}":{"patch":{"description":"Merged over the stored fixture, one level deep for nested objects such as the address — exactly as the fixture itself is merged over generated data. Use it to make a company change between two requests, which is what a monitoring integration needs to see a real change detected.","operationId":"SandboxFixturesController_update_v2","parameters":[{"name":"countryCode","required":true,"in":"path","schema":{"example":"FR","type":"string"}},{"name":"identifier","required":true,"in":"path","schema":{"example":"552100554","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSandboxFixtureDto"}}}},"responses":{"200":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Change a company you defined","tags":["Sandbox"]},"delete":{"description":"The identifier goes back to returning generated data.","operationId":"SandboxFixturesController_remove_v2","parameters":[{"name":"countryCode","required":true,"in":"path","schema":{"example":"FR","type":"string"}},{"name":"identifier","required":true,"in":"path","schema":{"example":"552100554","type":"string"}}],"responses":{"204":{"description":""}},"security":[{"x-api-key":[]}],"summary":"Undefine a company","tags":["Sandbox"]}},"/v2/billing/balance":{"get":{"description":"Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.","operationId":"BillingBalanceController_getBalance_v2","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceResponseDto"}}}}},"security":[{"x-api-key":[]}],"summary":"Get the current account credit balance","tags":["Billing"]}},"/v2/billing/notifications/config":{"get":{"operationId":"BillingNotificationsController_getConfig_v2","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedBillingNotificationConfigDto"}}}}},"security":[{"x-api-key":[]}],"summary":"Get resolved billing notification config (defaults merged)","tags":["Billing Notifications"]},"patch":{"operationId":"BillingNotificationsController_updateConfig_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingNotificationConfigDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolvedBillingNotificationConfigDto"}}}}},"security":[{"x-api-key":[]}],"summary":"Upsert billing notification config","tags":["Billing Notifications"]}},"/v2/billing/notifications/recent":{"get":{"operationId":"BillingNotificationsController_listRecent_v2","parameters":[{"name":"limit","required":false,"in":"query","description":"Max events to return (1–200, default 50).","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BillingNotificationEventDto"}}}}}},"security":[{"x-api-key":[]}],"summary":"List recent billing notification events","tags":["Billing Notifications"]}},"/v2/billing/notifications/workspaces/{workspaceId}/config":{"get":{"operationId":"BillingNotificationsController_getWorkspaceOverride_v2","parameters":[{"name":"workspaceId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceBillingNotificationViewDto"}}}}},"security":[{"x-api-key":[]}],"summary":"Get resolved workspace billing notification view (override + account)","tags":["Billing Notifications"]},"patch":{"operationId":"BillingNotificationsController_upsertWorkspaceOverride_v2","parameters":[{"name":"workspaceId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspaceHighUsageOverrideDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingNotificationWorkspaceOverrideDto"}}}}},"security":[{"x-api-key":[]}],"summary":"Upsert workspace high-usage override","tags":["Billing Notifications"]},"delete":{"operationId":"BillingNotificationsController_deleteWorkspaceOverride_v2","parameters":[{"name":"workspaceId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWorkspaceOverrideResponseDto"}}}}},"security":[{"x-api-key":[]}],"summary":"Remove workspace high-usage override","tags":["Billing Notifications"]}}},"info":{"title":"Topograph","description":"The Topograph API","version":"0.1","contact":{}},"tags":[],"servers":[{"url":"https://api.topograph.co"}],"components":{"securitySchemes":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"PricingBlockDTO":{"type":"object","properties":{"sku":{"type":"string","description":"Block SKU identifier","example":"ita-company-data"},"datapoints":{"description":"Datapoints covered by this block, and the scope one purchase bills for. A mode may serve fewer of them — read `modes.<mode>.datapoints` for what a given mode returns.","example":["company","legalRepresentatives"],"type":"array","items":{"type":"string"}},"modes":{"type":"object","description":"Pricing per mode. null means the block is not available in that mode."},"includedDocuments":{"description":"Document types included free when this block is purchased","example":["trade_register_extract"],"type":"array","items":{"type":"string"}}},"required":["sku","datapoints","modes"]},"PricingAndAvailabilityDTO":{"type":"object","properties":{"available":{"type":"boolean","description":"Whether the data point is available for this country","example":true},"price":{"type":"number","description":"The price in credits for this data point (verification mode)","example":1.5},"pricingMode":{"type":"string","description":"Whether the price is fixed or variable (determined at request time). Omitted when fixed.","example":"variable","enum":["fixed","variable"]}},"required":["available","price"]},"MonitoringCoverageDTO":{"type":"object","properties":{"datapoints":{"description":"Datapoints included in monitoring.","example":["company"],"type":"array","items":{"type":"string"}},"mode":{"type":"string","description":"Whether monitoring reads a live record or a published snapshot.","enum":["live","snapshot"]},"sources":{"description":"Public register codes for the monitoring sources.","type":"array","items":{"type":"string"}},"sourceFrequency":{"type":"string","description":"Source publication cadence. Daily checks can observe a snapshot only after publication and import.","enum":["daily","weekly","monthly"]},"note":{"type":"string","description":"Country-specific freshness and coverage limitations."}},"required":["datapoints"]},"GetPricingResultDTO":{"type":"object","properties":{"blocks":{"description":"Data blocks with per-mode pricing, datapoint coverage, and included documents","type":"array","items":{"$ref":"#/components/schemas/PricingBlockDTO"}},"companyProfile":{"deprecated":true,"description":"Legacy pricing field. New companyProfile requests are rejected from December 1, 2026 at 00:00 UTC. Use blocks or the explicit datapoint pricing fields for new integrations.","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"company":{"description":"Company data pricing","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"legalRepresentatives":{"description":"Legal representatives pricing (included in company block)","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"otherKeyPersons":{"description":"Other key persons pricing (included in company block)","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"establishments":{"description":"Establishments pricing (included in company block)","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"ultimateBeneficialOwners":{"description":"Ultimate beneficial owners pricing","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"shareholders":{"description":"Shareholders pricing","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"subsidiaries":{"description":"Subsidiaries pricing (downstream equity participations)","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"availableDocuments":{"description":"Available documents (always free)","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"graph":{"description":"Ownership graph pricing","allOf":[{"$ref":"#/components/schemas/PricingAndAvailabilityDTO"}]},"monitoring":{"description":"Monitored datapoints, with the source mode, publication frequency and limitations when explicitly configured.","allOf":[{"$ref":"#/components/schemas/MonitoringCoverageDTO"}]}},"required":["blocks","companyProfile","ultimateBeneficialOwners","availableDocuments"]},"CreateMonitorDto":{"type":"object","properties":{"companyId":{"type":"string","description":"The company ID to monitor","example":"123456789"},"countryCode":{"type":"string","description":"The country code for the company","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"],"example":"DE"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"example":{"caseId":"case-12345"},"description":"Arbitrary key-value string pairs to associate with the monitor, echoed back in monitor responses and in every monitor.notification webhook. Use it to map notifications back to your internal records (e.g. a case ID). Calling POST /v2/monitors again for the same company replaces the stored metadata when the field is provided. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated)."}},"required":["companyId","countryCode"]},"MonitorDatapointNoticeDto":{"type":"object","properties":{"datapoint":{"type":"string","description":"Datapoint affected","example":"ultimateBeneficialOwners"},"status":{"type":"string","description":"This datapoint will not be included in scheduled rechecks until the account configures its own credentials.","example":"blocked_missing_credentials"},"message":{"type":"string","description":"Human-readable explanation, safe to display to the account admin.","example":"This datapoint requires account-specific credentials that have not been configured. Configure them in the workspace vault, or contact support@topograph.co."}},"required":["datapoint","status","message"]},"CreateMonitorResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the monitor","example":"cmfzlu1dt000j12ldeqrfszq0"},"companyId":{"type":"string","description":"The company ID being monitored","example":"123456789"},"countryCode":{"type":"string","description":"The country code for the monitored company","example":"DE"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"example":{"caseId":"case-12345"},"description":"Key-value pairs provided at monitor creation, echoed back in responses and monitor.notification webhooks."},"datapointNotices":{"description":"Present when one or more monitored datapoints for this account are currently blocked on missing account credentials. The monitor is still created (other datapoints are unaffected) but these will not be fetched until resolved.","type":"array","items":{"$ref":"#/components/schemas/MonitorDatapointNoticeDto"}}},"required":["id","companyId","countryCode"]},"ListMonitorsDto":{"type":"object","properties":{"companyId":{"type":"string","description":"Filter by company ID","example":"123456789"},"countryCode":{"type":"string","description":"Filter by country code (ISO 2-letter)","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"],"example":"DE"},"after":{"type":"string","description":"Cursor for pagination","example":"cmfzlu1dt000j12ldeqrfszq0"},"first":{"type":"number","description":"Number of items to fetch (default: 50)","example":25,"minimum":1}}},"MonitorDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the monitor","example":"cmfzlu1dt000j12ldeqrfszq0"},"companyId":{"type":"string","description":"The company ID being monitored","example":"123456789"},"countryCode":{"type":"string","description":"The country code for the monitored company","example":"DE"},"companyName":{"type":"string","description":"The legal name of the monitored company","example":"Topograph SAS","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"example":{"caseId":"case-12345"},"description":"Key-value pairs provided at monitor creation, echoed back in responses and monitor.notification webhooks."}},"required":["id","companyId","countryCode"]},"ListMonitorsResponseDto":{"type":"object","properties":{"monitors":{"description":"List of monitored companies","type":"array","items":{"$ref":"#/components/schemas/MonitorDto"}},"total":{"type":"number","description":"Total number of monitors","example":10},"hasNextPage":{"type":"boolean","description":"Whether there is a next page available","example":true},"nextCursor":{"type":"string","description":"Cursor for the next page","example":"cmfzlu1dt000j12ldeqrfszq0"}},"required":["monitors","total","hasNextPage"]},"MonitorDetailsResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the monitor","example":"cmfzlu1dt000j12ldeqrfszq0"},"companyId":{"type":"string","description":"The company ID being monitored","example":"123456789"},"countryCode":{"type":"string","description":"The country code for the monitored company","example":"DE"},"lastFetchedAt":{"type":"string","description":"When the monitor data was last fetched, or null before the first fetch.","example":"2026-03-20T02:00:00.000Z","nullable":true},"createdAt":{"type":"string","description":"When the monitor was created","example":"2026-01-15T10:30:00.000Z"},"companyName":{"type":"string","description":"The legal name of the monitored company","example":"Topograph SAS","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string"},"example":{"caseId":"case-12345"},"description":"Key-value pairs provided at monitor creation, echoed back in responses and monitor.notification webhooks."}},"required":["id","companyId","countryCode","lastFetchedAt","createdAt"]},"MonitorLogDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the log entry","example":"cmfzlu1dt000j12ldeqrfszq0"},"changeDetected":{"type":"boolean","description":"Whether a change was detected in this check","example":true},"changeCategories":{"description":"Categories of detected changes","example":["status","address"],"type":"array","items":{"type":"string"}},"fetchStatus":{"type":"string","description":"Status of the fetch operation","example":"success","enum":["success","not_found","error","error_final"]},"errorMessage":{"type":"string","description":"Error message if the fetch failed","example":null,"nullable":true},"createdAt":{"type":"string","description":"When this log entry was created","example":"2026-03-20T02:00:00.000Z"}},"required":["id","changeDetected","changeCategories","fetchStatus","createdAt"]},"MonitorLogsResponseDto":{"type":"object","properties":{"logs":{"description":"List of monitor log entries","type":"array","items":{"$ref":"#/components/schemas/MonitorLogDto"}},"hasNextPage":{"type":"boolean","description":"Whether there is a next page available","example":true},"nextCursor":{"type":"string","description":"Cursor for the next page","example":"cmfzlu1dt000j12ldeqrfszq0"}},"required":["logs","hasNextPage"]},"SendTestNotificationDto":{"type":"object","properties":{"changeCategories":{"type":"array","description":"Change categories to put on the test event. Defaults to [\"other\"]. These are the same categories a real change emits, so pick one your integration routes on.","example":["other"],"items":{"type":"string","enum":["status","address","ownership","financial","other","disappeared"]}},"monitorHasBeenDeactivated":{"type":"boolean","description":"Send monitorHasBeenDeactivated: true, so you can exercise your deactivation branch. The monitor itself stays active.","default":false,"example":false}}},"SendTestNotificationResponseDto":{"type":"object","properties":{"payload":{"type":"object","description":"The exact payload delivered to your webhook endpoint.","example":{"type":"monitor.notification","monitorId":"cmfzlu1dt000j12ldeqrfszq0","companyId":"123456789","countryCode":"DE","timestamp":"2026-03-20T02:00:00.000Z","changeCategories":["other"],"monitorHasBeenDeactivated":false,"metadata":{"caseId":"case-12345"}},"additionalProperties":true}},"required":["payload"]},"SearchMonitorAddressDto":{"type":"object","properties":{"addressLine1":{"type":"string","example":"10 rue de la Paix"},"city":{"type":"string","example":"Saint-Malo"},"postalCode":{"type":"string","example":"35400"}}},"CreateSearchMonitorDto":{"type":"object","properties":{"countryCode":{"type":"string","enum":["FR"],"example":"FR","description":"Search monitoring is currently available for France."},"query":{"type":"string","example":"Dupont Conseil","description":"Company name to watch. Supply address constraints separately. Every word must match; punctuation and accents are ignored."},"address":{"description":"Every supplied address constraint must match. Missing address data does not match.","allOf":[{"$ref":"#/components/schemas/SearchMonitorAddressDto"}]},"expiresAt":{"type":"string","description":"Expiration, at most 30 days from creation. Defaults to 30 days."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Customer metadata echoed in match notifications."}},"required":["countryCode","query"]},"SearchMonitorCandidateDto":{"type":"object","properties":{"id":{"type":"string","example":"932884117"},"countryCode":{"type":"string","enum":["FR"]},"legalName":{"type":"string","example":"DUPONT CONSEIL"},"address":{"$ref":"#/components/schemas/SearchMonitorAddressDto"}},"required":["id","countryCode","legalName","address"]},"CreateSearchMonitorResponseDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","enum":["FR"]},"query":{"type":"string"},"address":{"$ref":"#/components/schemas/SearchMonitorAddressDto"},"status":{"type":"string","enum":["active","stopped","expired"]},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastCheckedAt":{"type":"string","format":"date-time"},"lastError":{"type":"string","description":"Why the latest check failed, for example a name that now matches too many companies. Checks continue hourly; absent once a check succeeds."},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"initialMatches":{"description":"Previously observed matches. On first creation these form the baseline and are not sent as new-match webhooks. Reposting returns the existing subscription and its remembered matches.","type":"array","items":{"$ref":"#/components/schemas/SearchMonitorCandidateDto"}}},"required":["id","countryCode","query","status","createdAt","expiresAt","initialMatches"]},"SearchMonitorDto":{"type":"object","properties":{"id":{"type":"string"},"countryCode":{"type":"string","enum":["FR"]},"query":{"type":"string"},"address":{"$ref":"#/components/schemas/SearchMonitorAddressDto"},"status":{"type":"string","enum":["active","stopped","expired"]},"createdAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"},"lastCheckedAt":{"type":"string","format":"date-time"},"lastError":{"type":"string","description":"Why the latest check failed, for example a name that now matches too many companies. Checks continue hourly; absent once a check succeeds."},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"required":["id","countryCode","query","status","createdAt","expiresAt"]},"ListSearchMonitorsResponseDto":{"type":"object","properties":{"monitors":{"type":"array","items":{"$ref":"#/components/schemas/SearchMonitorDto"}},"nextCursor":{"type":"string"}},"required":["monitors"]},"AddressDTO":{"type":"object","properties":{"addressLine1":{"type":"string","description":"First line of the address","example":"10 rue de la Fraternité"},"addressLine2":{"type":"string","description":"Second line of the address","example":"Topograph Building"},"city":{"type":"string","description":"City of the address","example":"Bagnolet"},"postalCode":{"type":"string","description":"Postal code of the address","example":"93170"},"region":{"type":"string","description":"Region of the address","example":"FR"},"countryCode":{"type":"string","description":"Country of the address using ISO 3166-1 alpha-2 country code","example":"FR"},"poBox":{"type":"string","description":"Post Office Box number","example":"PO Box 123"},"careOf":{"type":"string","description":"Care of (c/o) recipient","example":"c/o John Doe"},"state":{"type":"string","description":"State of the address","example":"Île-de-France"},"latitude":{"type":"number","description":"Latitude coordinate","example":59.9139},"longitude":{"type":"number","description":"Longitude coordinate","example":10.7522}}},"JapanIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"houjinBango":{"type":"string","example":"1470003000008","description":"法人番号 (Hōjin Bangō), exactly 13 digits including the leading check digit. This is distinct from the 12-digit MOJ company number and from an invoice registration identifier beginning with T."}},"description":"Identifiers for Japanese legal entities"},"AntiguaBarbudaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"entityNumber":{"type":"string","description":"Entity Number issued by the Antigua and Barbuda Intellectual Property and Commerce Office (IPCO). Format: an uppercase \"C\", sometimes followed by a space, then 1 to 4 digits, optionally followed by a slash and a 2- or 4-digit year; with a 4-digit year the number is zero-padded to 4 digits. Examples: \"C8093\", \"C84/09\", \"C0728/2025\", \"C 2836\". Pass it exactly as returned, space included.","example":"C8093"}},"description":"Identifiers for Antigua and Barbuda companies (AG)"},"ItalyIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived from the register tax code for supported Italian limited companies.","example":"ITRI.00484960588"},"VAT":{"type":"string","description":"Partita IVA (P.IVA) - VAT registration number. Format: 11 digits, the last a check digit, without the IT prefix (e.g., \"00905811006\"). Usually equal to the company codice fiscale, but not always. Issued by: Agenzia delle Entrate (Revenue Agency)","example":"00905811006"},"codiceFiscale":{"type":"string","description":"Codice Fiscale - Tax identification code. Format: 11 digits for companies, the last a check digit (e.g., \"00484960588\"), or, for a sole proprietorship, the 16-character personal codice fiscale of the owner (e.g., \"BRNLSN75H27B564E\"). Issued by: Agenzia delle Entrate (Revenue Agency)","example":"00484960588"},"cciaa":{"type":"string","description":"CCIAA - Camera di Commercio (Chamber of Commerce) province code. Format: 2-letter province code (e.g., \"RM\" for Roma, \"MI\" for Milano). Indicates which Chamber of Commerce the company is registered with.","example":"RM"},"rea":{"type":"string","description":"REA number - Registro Economico Amministrativo (Economic Administrative Register) number. Format: 1 to 7 digits (e.g., \"756453\"). Unique within each CCIAA province. Combined with CCIAA forms a unique identifier.","example":"756453"},"Codice Fiscale":{"type":"string","deprecated":true,"description":"Deprecated legacy alias of `codiceFiscale` — use `codiceFiscale`. Emitted until 2026-09-01.","example":"00484960588"},"CCIAA":{"type":"string","deprecated":true,"description":"Deprecated legacy alias of `cciaa` — use `cciaa`. Emitted until 2026-09-01.","example":"RM"},"REA Code":{"type":"string","deprecated":true,"description":"Deprecated legacy alias of `rea` — use `rea`. Emitted until 2026-09-01.","example":"756453"}},"description":"Identifiers for Italian companies (IT)"},"FranceIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"siren":{"type":"string","description":"SIREN - Système d'Identification du Répertoire des Entreprises. Format: 9 digits, leading zeros significant (e.g., \"443061841\", \"085880458\"); the ninth digit is a check digit (Luhn). Issued by: INSEE (Institut National de la Statistique et des Études Économiques). This is the primary company identifier in France.","example":"443061841"},"siret":{"type":"string","description":"SIRET - Système d'Identification du Répertoire des Établissements. Format: 14 digits = SIREN (9) + NIC (5) (e.g., \"44306184100047\"); the last digit is a check digit. Identifies a specific establishment (location) of a company, normally the head office. Issued by: INSEE.","example":"44306184100047"},"VAT":{"type":"string","description":"TVA Intracommunautaire - French VAT number. Format: 11 digits, a 2-digit key followed by the SIREN (e.g., \"64443061841\"); the FR prefix is stripped in the response. Issued by: Direction Générale des Finances Publiques (DGFiP). Required for EU cross-border transactions.","example":"64443061841"},"rna":{"type":"string","description":"RNA - Répertoire National des Associations. Waldec associations use \"W\" + 9 characters: 9 digits (e.g., \"W073000441\"), or in Corsica 2A/2B + 7 digits. Older RNA-Import associations use up to 15 letters, digits and hyphens, typically 3 digits, a letter, then digits (e.g., \"332P2214500\", \"051S00-011\"). Every RNA id contains an uppercase letter. Alsace-Moselle associations carry one only when the register records it. Issued by: Préfecture.","example":"W073000441"},"rnaAlsaceMoselle":{"type":"string","description":"RNA Alsace-Moselle (AMALIA number) - identifier for associations registered under local law (droit local) in the Alsace-Moselle region. Format: 14 characters, A + 4 digits (usually the year of registration) + 3-letter court code + 6 digits (e.g., \"A2002THI000075\"). This is the id search returns for these associations.","example":"A2002THI000075"}},"description":"Identifiers for French companies (FR)"},"FrenchPolynesiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"numeroTahiti":{"type":"string","description":"Numéro TAHITI issued by the Institut de la Statistique de la Polynésie Française (ISPF). Format: 6 digits (legacy registrations), or 1 letter followed by 5 digits for registrations made since October 2011. Both formats are in current use.","example":"826990"}},"description":"Identifiers for French Polynesia companies (PF)"},"AustriaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"firmenbuchnummer":{"type":"string","description":"Firmenbuchnummer - Company registration number. Format: digits followed by a lowercase check letter, no space (e.g., \"184018s\"). Issued by: Firmenbuch (Company Register).","example":"184018s"},"VAT":{"type":"string","description":"VAT number (USt-IdNr/UID) without ATU prefix. Format: U + 8 digits, the last one a check digit (e.g., \"U47318406\"). Full format: ATU47318406. Note: VAT number is not derivable from Firmenbuchnummer and must be obtained separately.","example":"U47318406"},"zvrNumber":{"type":"string","description":"ZVR number (Vereinsregisternummer) — Central Association Register number. Format: 1-10 digits (e.g., \"432857691\"). Issued by: Zentrales Vereinsregister (BMI).","example":"432857691"},"gisaZahl":{"type":"string","description":"GISA-Zahl — Trade licence number from the Austrian Trade Information System. Format: digits, 8 in every record we have seen (e.g., \"10118573\"). Issued by: GISA (Gewerbeinformationssystem Austria).","example":"10118573"},"euid":{"type":"string","description":"EUID (European Unique Identifier) — Cross-border company identifier assigned by the Firmenbuch under the EU Company Law Directive. Format: ATBRA. + the Firmenbuch number padded to 6 digits without its check letter + -000 (e.g., \"ATBRA.184018-000\"). Issued by: Firmenbuch (Company Register).","example":"ATBRA.184018-000"},"EUID":{"type":"string","deprecated":true,"description":"Deprecated legacy alias of `euid` — use `euid`. Emitted until 2026-09-01.","example":"ATBRA.184018-000"}},"description":"Identifiers for Austrian companies (AT)"},"BelgiumIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"BEKBOBCE.0403.170.701"},"ondernemingsnummer":{"type":"string","description":"Enterprise Number (Ondernemingsnummer) - Unique identifier for Belgian companies. Format: 10 digits, returned with dots as NNNN.NNN.NNN (e.g., \"0403.170.701\"). The first digit is 0 or 1 (numbers issued since September 2023 start with 1); the last two digits are check digits (97 minus the first eight digits modulo 97). Issued by: Crossroads Bank for Enterprises (CBE).","example":"0403.170.701"},"VAT":{"type":"string","description":"VAT number (BTW nummer) without BE prefix. In Belgium, the VAT number equals the enterprise number (10 digits starting with 0 or 1). Format: 10 digits, no dots (e.g., \"0403170701\"). Full format: BE0403170701. Derived from the enterprise number, so it is returned whether or not the entity is registered for VAT.","example":"0403170701"},"Numéro BCE":{"type":"string","deprecated":true,"description":"Deprecated legacy alias of `ondernemingsnummer` — use `ondernemingsnummer`. Emitted until 2026-09-01.","example":"0425.258.688"}},"description":"Identifiers for Belgian companies (BE)"},"BrazilIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"cnpj":{"type":"string","description":"Cadastro Nacional da Pessoa Jurídica (CNPJ), issued by Receita Federal. 14 characters: 12 uppercase letters A–Z or digits followed by two numeric check digits. Existing numeric CNPJs remain valid. Returned without punctuation, retaining leading zeros; formatted input such as 00.000.000/E08G-12 is accepted. Each establishment has its own CNPJ.","example":"19131243000197"}},"description":"Identifiers for Brazilian entities (BR)"},"SwitzerlandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"uid":{"type":"string","description":"UID (Unternehmens-Identifikationsnummer) - Swiss company identification number. Format: CHE followed by 9 digits, without separators (e.g., \"CHE408600128\"); the register also writes it CHE-408.600.128. The last digit is a check digit (modulo 11). Issued by: Federal Statistical Office.","example":"CHE408600128"},"ehraId":{"type":"string","description":"EHRA-ID - Internal identifier of the Swiss federal commercial-register central database. Format: 1 to 7 digits (e.g., \"1499050\"). Issued by: Federal Office of Justice (EHRA).","example":"1499050"},"chId":{"type":"string","description":"CH-ID - Former commercial-register number, no longer used in public. Format: CH followed by 11 digits, without separators (e.g., \"CH55011976311\").","example":"CH55011976311"}},"description":"Identifiers for Swiss companies (CH)"},"ChinaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"uscc":{"type":"string","description":"USCC (Unified Social Credit Code, 统一社会信用代码). Format: 18 characters, digits and uppercase letters (never I, O, S, V or Z), the last one a check character (e.g., \"9144030071526726XG\"). Some codes are all digits (e.g., \"911000001000013428\"). Issued by: the entity's registration authority, under national standard GB 32100-2015.","example":"9144030071526726XG"}},"description":"Identifiers for Chinese companies (CN)"},"CyprusIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Registration Number - Company registration number in Cyprus. Format: a prefix followed by 1 to 6 digits, no space, no leading zeros (e.g., \"ΗΕ433437\", \"ΕΕ25556\", \"Σ2536\", \"ΑΕ1677\", \"BN1\"). ΗΕ, ΕΕ, Σ and ΑΕ are Greek letters, not their Latin look-alikes; BN is Latin. The prefix is the entity type: ΗΕ company, ΕΕ business name, Σ partnership, ΑΕ overseas company, BN partnership registered as a business name. Issued by: Department of Registrar of Companies and Intellectual Property.","example":"ΗΕ433437"},"euid":{"type":"string","description":"European Unique Identifier (EUID): CYDRCOR.HE + the registration number digits, HE in Latin letters. Available for domestic private and public limited companies. Older onboarding profiles may omit it.","example":"CYDRCOR.HE433437"}},"description":"Identifiers for Cypriot companies (CY)"},"CzechiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"CZVROR.04234651"},"ico":{"type":"string","description":"IČO (Identifikační číslo osoby) - Company identification number. Format: 8 digits, the last one a check digit (e.g., \"45274649\"). Issued by: Czech Statistical Office.","example":"45274649"},"dic":{"type":"string","description":"DIČ (Daňové identifikační číslo) - Tax identification number. Format: CZ prefix + 8-10 digits (e.g., \"CZ45274649\"). For companies, this is typically CZ + IČO.","example":"CZ45274649"},"VAT":{"type":"string","description":"VAT number (DIČ) without CZ prefix. Format: 8-10 digits. For companies, this is typically the same as IČO.","example":"45274649"}},"description":"Identifiers for Czech companies (CZ)"},"GermanyIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registerCourt":{"type":"string","description":"The local court (Amtsgericht) that maintains the register entry. Together with registerType and registerNumber this forms the full German commercial-register identifier (e.g. \"München\" in \"München HRB 228960\").","example":"München"},"registerType":{"type":"string","description":"The register section: HRB (Handelsregister B – capital companies), HRA (Handelsregister A – partnerships / sole traders), VR (Vereinsregister – associations), PR (Partnerschaftsregister), GnR (Genossenschaftsregister – cooperatives; GenR in a company id is returned as GnR), GsR (Gesellschaftsregister, registered civil-law partnerships).","example":"HRB"},"registerNumber":{"type":"string","description":"The register entry number (e.g. \"228960\" in \"München HRB 228960\"), up to 6 digits in the records we have seen, with any letter suffix the court adds kept after a space.","example":"228960"},"VAT":{"type":"string","description":"VAT identification number (USt-IdNr). Format: DE + 9 digits, the last a check digit. Issued by: Bundeszentralamt für Steuern.","example":"DE143454214"},"euid":{"type":"string","description":"European Unique Identifier returned by the German commercial register when available.","example":"DED2601V.HRB180911"}},"description":"Identifiers for German companies (DE)"},"DenmarkIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"DKCVR.25450442"},"cvr":{"type":"string","description":"CVR Number (Central Business Register) - Company registration number. Format: 8 digits, no separators; the last digit is a modulus-11 check digit (e.g., \"25450442\"). Issued by: Danish Business Authority (Erhvervsstyrelsen).","example":"25450442"},"VAT":{"type":"string","description":"VAT number (Momsregistreringsnummer) without DK prefix. Format: 8 digits, identical to the CVR number. Returned for every entity, derived from the CVR number: its presence alone does not mean the entity is registered for VAT.","example":"25450442"},"enhedsNummer":{"type":"string","description":"Unit number (Enhedsnummer) - Internal CVR identifier for the business unit. Format: up to 10 digits (e.g., \"4001459308\"). Issued by: Danish Business Authority (Erhvervsstyrelsen).","example":"4001459308"}},"description":"Identifiers for Danish companies (DK)"},"EstoniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"EEARIREG.12417834"},"registryCode":{"type":"string","description":"Registrikood - Registry code. Format: 8 digits, no separators or prefix (e.g., \"12417834\"). Issued by: Business Register (Äriregister).","example":"12417834"},"VAT":{"type":"string","description":"VAT number (KMKR number) without EE prefix. Format: 9 digits (e.g., \"102090374\"). Present when the Business Register lists a VAT number for the entity.","example":"102090374"}},"description":"Identifiers for Estonian companies (EE)"},"FaroeIslandsIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"skrasetingarnummar":{"type":"string","description":"Registration number (Skrásetingarnummar) issued by Skráseting Føroya, the Faroese company register. Digits only, without leading zeros or a prefix: 1 to 5 digits in the records seen so far (e.g. \"10\", \"2695\", \"10100\").","example":"2695"}},"description":"Identifiers for Faroe Islands companies (FO)"},"PhilippinesIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"cdaRegistrationNumber":{"type":"string","description":"Registration number published by the Cooperative Development Authority (CDA). Preserve prefixes, hyphens and leading zeros. This is distinct from an SEC number, DTI business-name number or BIR TIN.","example":"9520-15005879"}},"description":"Identifiers for Philippine cooperatives (PH)"},"FinlandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"businessId":{"type":"string","description":"Business ID (Y-Tunnus) - Finnish business identification number. Format: 7 digits, hyphen, 1 modulus-11 check digit (e.g., \"0112038-9\"); leading zeros are significant. Issued by: Finnish Business Information System (YTJ).","example":"0112038-9"},"VAT":{"type":"string","description":"VAT number (ALV-numero) without FI prefix. Format: 8 digits (Business ID without hyphen). In Finland, VAT = FI + Business ID without dash.","example":"01120389"},"euid":{"type":"string","description":"European Unique Identifier returned by the Finnish Business Information System when available.","example":"FIFPRO.0112038-9"}},"description":"Identifiers for Finnish companies (FI)"},"GuernseyIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registryNumber":{"type":"string","description":"Registry Number - registration number issued by the Guernsey Registry. Format: an uppercase letter prefix followed by digits, no space or leading zeros (e.g. \"CMP10001\", \"LP2515\", \"FND167\", \"CH416\", \"NP69\"). The prefix names the register: CMP (companies), LP (limited partnerships), LLP (limited liability partnerships), FND (foundations), CH (charities), NP (other non-profit organisations). Each register numbers its entities separately, so keep the prefix.","example":"CMP10001"}},"description":"Identifiers for Guernsey companies (GG)"},"HongKongIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"brn":{"type":"string","description":"BRN (Business Registration Number) - the Unique Business Identifier of a Hong Kong company. Format: 8 digits, leading zeros significant (e.g., \"77054426\"), or, for a company without a BRN, a dummy BRN of a letter prefix and 7 digits (e.g., \"C1300723\"). Issued by: Inland Revenue Department (Business Registration Office); dummy BRNs by the Companies Registry.","example":"77054426"}},"description":"Identifiers for Hong Kong companies (HK)"},"CroatiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"mbs":{"type":"string","description":"MBS (Matični broj subjekta) - Company registration number. Format: 9 digits, leading zeros significant: a 2-digit court number, a 6-digit sequence number and a check digit (e.g., \"010006782\"). Issued by: Court Register (Sudski registar).","example":"010006782"},"oib":{"type":"string","description":"OIB (Osobni identifikacijski broj) - Tax identification number. Format: 11 digits, the last one a check digit (e.g., \"09520995772\"). Issued by: Tax Administration.","example":"09520995772"},"VAT":{"type":"string","description":"VAT number (PDV broj) without HR prefix. Format: 11 digits (same as OIB). In Croatia, OIB equals VAT number.","example":"09520995772"},"mb":{"type":"string","description":"MB (Matični broj) - Statistical registration number. Format: 8 digits at the register, returned as a number, so a leading zero is dropped (e.g., \"03805131\" is returned as \"3805131\"). Issued by: Croatian Bureau of Statistics (DZS).","example":"03805131"},"euid":{"type":"string","description":"EUID (European Unique Identifier) - cross-border BRIS identifier. Format: HRSR. followed by the 9-digit MBS (e.g., \"HRSR.010006782\"). Issued by: Court Register (Sudski registar) via BRIS.","example":"HRSR.010006782"}},"description":"Identifiers for Croatian companies (HR)"},"HungaryIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"companyNumber":{"type":"string","description":"Company Number (Cégjegyzékszám) - Company registration number issued by the Court of Registration. Format: 10 digits with no separators (e.g., \"0109430929\" for Cg. 01-09-430929): court code, company form code and 6-digit sequence number.","example":"0109430929"},"taxNumber":{"type":"string","description":"Tax Number (Adószám) - Full tax identification number. Format: 11 digits, usually written xxxxxxxx-y-zz (e.g., \"32565144-2-41\") and sometimes without hyphens. The first 8 digits form the EU VAT number (HU + first 8 digits).","example":"32565144-2-41"},"VAT":{"type":"string","description":"VAT number (ÁFA szám) without HU prefix. Format: First 8 digits of the tax number. In Hungary, VAT = HU + first 8 digits of tax number.","example":"32565144"},"evnyRegistrationNumber":{"type":"string","description":"EVNY Registration Number (Nyilvántartási szám) for sole traders. Format: 8 digits. Sole traders are registered in the EVNY registry, separate from the Cégjegyzék (company registry).","example":"56109748"},"vatGroupNumber":{"type":"string","description":"Group VAT number (Csoportos adószám) - Assigned when the company is part of a Hungarian VAT group. Both the regular tax number and this group tax number must appear on invoices. Format: xxxxxxxx-y-zz (11 digits with hyphens). Sourced from NAV (Hungarian Tax and Customs Authority).","example":"17783666-5-41"},"statisticalCode":{"type":"string","description":"Statistical code (KSH szám) - Identifier assigned by the Hungarian Central Statistical Office (KSH). Format: 17 digits, usually written 8-4-3-2 with hyphens (e.g., \"32565144-4740-113-01\"): tax base number, main activity code, economic form code and county code. Present for court-registered companies (from section 20 of the Cégkivonat) and for sole traders (from the EVNY registry).","example":"32565144-4740-113-01"},"euid":{"type":"string","description":"European Unique Identifier (EUID) - Cross-border identifier issued by the Hungarian Court of Registration. Format: HUOCCSZ.CC-TT-NNNNNN. Present for court-registered companies (from section 60 of the Cégkivonat).","example":"HUOCCSZ.01-09-430929"}},"description":"Identifiers for Hungarian companies (HU)"},"IcelandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"kennitala":{"type":"string","description":"Kennitala (National ID / Registration number). Format: 10 digits, no separator (e.g., \"5602151420\"). For legal entities 40 is added to the day in the first two digits (41-71); a sole trader is identified by the personal kennitala of the owner (01-31). The 9th digit is a check digit, the 10th marks the century. Issued by: Skatturinn (Iceland Revenue and Customs) for entities in the company register.","example":"5602151420"},"VAT":{"type":"string","description":"VAT number (Virðisaukaskattsnúmer). 5 or 6 digits with no prefix in the records we have seen (e.g., \"119978\"), as issued by the Icelandic tax authority (Skatturinn). Present only when the register lists a VAT number for the entity.","example":"119978"}},"description":"Identifiers for Icelandic companies (IS)"},"IrelandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"IECRO.368047"},"companyNumber":{"type":"string","description":"Company Number - CRO registration number issued by the Companies Registration Office. Format: digits only, no leading zeros (1 to 6 digits in the records we have seen, e.g. \"368047\"). For a registered business name, search results and company.id carry the number with a \"-B\" suffix (e.g. \"131910-B\"), while this field carries the bare number. A limited partnership has its own number, \"LP\" followed by digits (e.g. \"LP694\"), here and in company.id.","example":"368047"}},"description":"Identifiers for Irish companies (IE)"},"IsleOfManIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Company Registration Number issued by the Isle of Man Companies Registry (Department of Enterprise). Format: exactly 6 digits, zero-padded, followed by one uppercase letter that indicates the registry type (C = 1931 Act Company, V = 2006 Act Company, B = Business Name, F = Foreign Company, L = Limited Liability Company, M = Foundation; the Registry's other registers, such as industrial societies and limited partnerships, use other letters, e.g. \"000006I\"). Example: \"099176C\", \"002092V\".","example":"099176C"}},"description":"Identifiers for Isle of Man companies (IM)"},"JerseyIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"companyNumber":{"type":"string","description":"Jersey Entity Identifier - the JFSC registration number and entity id, hyphen-joined, digits only on both sides (e.g. \"3499-3005057\", \"116051-300359\"). Registered business names keep their RBN or BNT prefix (e.g. \"BNT12894-168806\"). The JFSC numbers each entity type in its own series, so a bare registration number can belong to several entities; the entity id disambiguates.","example":"3499-3005057"}},"description":"Identifiers for Jersey companies (JE)"},"LiechtensteinIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"flNumber":{"type":"string","description":"FL-Nummer - Company registration number issued by the Office of Justice. Format: FL- followed by 10 digits grouped 4.3.3, a hyphen and a check digit (e.g., \"FL-0001.548.501-4\").","example":"FL-0001.548.501-4"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Available in onboarding for Aktiengesellschaft companies with a confirmed register identity.","example":"LIFL.FL-0001.548.501-4"}},"description":"Identifiers for Liechtenstein companies (LI)"},"LuxembourgIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"rcs":{"type":"string","description":"RCS (Registre de Commerce et des Sociétés) - Company registration number. Format: one uppercase letter (the register section, A to O) followed by digits, with no space (e.g., \"B246607\", \"F6\", \"K1206\").","example":"B246607"},"VAT":{"type":"string","description":"VAT number (Numéro de TVA intracommunautaire) without LU prefix. Format: 8 digits (e.g., 32326416).","example":"32326416"},"euid":{"type":"string","description":"European Unique Identifier returned by the Luxembourg trade register when available. Format: LURCSL. followed by the RCS number (e.g., \"LURCSL.B781\").","example":"LURCSL.B781"}},"description":"Identifiers for Luxembourg companies (LU)"},"LatviaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Returned for SIA and AS companies with a register-confirmed registration number and legal form.","example":"LVUR.50003090101"},"registrationNumber":{"type":"string","description":"Registration Number - Company registration number. Format: digits only, no separators. Most entities: 11 digits (e.g., \"50003090101\"). Some older entries: 9 digits, leading zeros significant (e.g., \"000307795\"). Issued by: Register of Enterprises (Uzņēmumu reģistrs).","example":"50003090101"},"foreignRegistrationNumber":{"type":"string","description":"Foreign Registration Number - Home-country registration number of a foreign entity, as recorded by the Latvian register in the format of that home register (e.g., \"930097705\", a Norwegian organisation number). Returned for foreign entities recorded in the Register of Enterprises.","example":"930097705"}},"description":"Identifiers for Latvian companies (LV)"},"PanamaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"folio":{"type":"string","description":"Public Register folio, with its module suffix for legacy records (for example 12086-S or 7-E). Modern folios without a module are numeric. The module is required to distinguish legacy records sharing the same number.","example":"12086-S"},"ruc":{"type":"string","description":"Registro Único de Contribuyentes, as published by the Public Register. Common format: three numeric groups separated by hyphens.","example":"130-377-34706"}},"description":"Panamanian company identifiers (PA)"},"HondurasIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"matricula":{"type":"string","description":"Complete mercantile record ID. SURE records use the registration district, matrícula and index separated by hyphens, with numeric parts zero-padded to 10 and 5 digits. CCIT records use CCIT- followed by the numeric matrícula to distinguish the separate Francisco Morazán register.","example":"FG-0000071768-00000"},"ccitMatricula":{"type":"string","description":"Numeric matrícula published by the CCIT mercantile register for Francisco Morazán. The company ID and primary matricula field prepend CCIT- to this number.","example":"2504124"}},"description":"Honduran mercantile identifiers (HN)"},"MexicoIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"fme":{"type":"string","description":"Folio Mercantil Electrónico (FME) as the Registro Público de Comercio writes it: digits for older folios (for example 772 or 17704), or N- followed by 10 digits for newer ones (for example N-2016040248). The FME is not unique: each register office numbers its own folios, and some offices hold several companies under the same FME, so it identifies a company only together with oficinaRegistral and folioSiger.","example":"772"},"oficinaRegistral":{"type":"string","description":"Code of the register office (oficina registral) that holds the folio: a number from 1 to 315 in the register’s national office catalogue (for example 202 for Córdoba, Veracruz).","example":"202"},"folioSiger":{"type":"string","description":"The register’s own number for the folio record (digits, for example 580869). It tells apart companies that share a register office and an FME. The company id is oficinaRegistral, fme and folioSiger joined by hyphens (for example 202-772-580869).","example":"580869"},"rfc":{"type":"string","description":"Registro Federal de Contribuyentes (RFC), the federal taxpayer number, as recorded in the company folio (12 characters for a company, for example PMC071110DC6). Returned only when the folio records it; not checked against the tax administration.","example":"PMC071110DC6"}},"description":"Mexican company identifiers (MX)"},"ColombiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"nit":{"type":"string","description":"Número de Identificación Tributaria (NIT) of the legal entity, without its verification digit, as indexed by the chambers of commerce in RUES. Usually 9 digits; legacy NITs have 6 to 8 digits and a few have 10. The form with the verification digit (899999068-1) and dotted input (899.999.068-1) are accepted and normalized.","example":"899999068"}},"description":"Colombian company identifiers (CO)"},"EcuadorIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"expediente":{"type":"string","description":"File number (expediente) assigned by the Superintendencia de Compañías, Valores y Seguros. Numeric, without leading zeros. Every company supervised by the Superintendencia has one, including companies registered before they obtained a RUC.","example":"78"},"ruc":{"type":"string","description":"Registro Único de Contribuyentes: 13 digits, ending in 001 for the main establishment. The id of every taxpayer the Superintendencia does not supervise (sole traders, cooperatives, associations, foundations, banks, public bodies); for a supervised company, returned when the Superintendencia publishes it.","example":"1790027740001"}},"description":"Ecuadorian company identifiers (EC)"},"BermudaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Registration number issued by the Bermuda Registrar of Companies. Digits only: older entities have numbers of up to 6 digits (for example 29407 or 9714); entities registered in recent years have 9-digit numbers that begin with the year of registration (for example 202606344).","example":"29407"}},"description":"Bermudian company identifiers (BM)"},"ArgentinaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"cuit":{"type":"string","description":"Clave Única de Identificación Tributaria: 11 digits, without hyphens. Issued by ARCA (the federal tax agency) and used as the national identifier of every company, whatever province it is registered in. Companies start with 30, 33 or 34.","example":"30703088534"}},"description":"Argentine company identifiers (AR)"},"ChileIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"rut":{"type":"string","description":"Rol Único Tributario: the 8-digit number, a hyphen and the check digit (0-9 or K), without dots. Issued by the Servicio de Impuestos Internos (SII) and used as the national identifier of every Chilean legal entity. Written 97.004.000-5 on official documents.","example":"97004000-5"}},"description":"Chilean company identifiers (CL)"},"UruguayIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"rut":{"type":"string","description":"Registro Único Tributario: 12 digits without separators, the last one a check digit. Issued by the Dirección General Impositiva (DGI) and used as the national identifier of every Uruguayan legal entity. Leading zeros are significant (020005810013).","example":"213534080019"}},"description":"Uruguayan company identifiers (UY)"},"ParaguayIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"ruc":{"type":"string","description":"Registro Único del Contribuyente of a legal entity, without its check digit: 8 digits beginning with 80. Issued by the Dirección Nacional de Ingresos Tributarios (DNIT). The check digit is returned in taxId (80099554-6).","example":"80099554"},"rucAnterior":{"type":"string","description":"The RUC the entity held before the current numbering, as the DNIT lists it next to the current RUC: upper-case letters followed by digits, sometimes ending with a letter (FITA177490S).","example":"FITA177490S"}},"description":"Paraguayan company identifiers (PY)"},"BoliviaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"matricula":{"type":"string","description":"Matrícula de comercio: the number under which the Servicio Plurinacional de Registro de Comercio (SEPREC) registers a company, digits only (9 or 10 digits for current numbers, for example 1015447026). Leading zeros are significant in a former number (00013675).","example":"1015447026"},"matriculaAnterior":{"type":"string","description":"Former matrícula: the 8-digit number issued by FUNDEMPRESA, the previous operator of the commercial register, kept by SEPREC for companies registered before the migration (for example 00013675). Leading zeros are significant.","example":"00013675"}},"description":"Bolivian company identifiers (BO)"},"DominicanRepublicIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"rnc":{"type":"string","description":"Registro Nacional de Contribuyentes: 9 digits without separators, the last one a check digit. Issued by the Dirección General de Impuestos Internos (DGII) to every Dominican legal entity. Companies start with 1; public bodies and non-profits start with 4.","example":"101003723"}},"description":"Dominican company identifiers (DO)"},"AustraliaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"acn":{"type":"string","description":"Australian Company Number (ACN) issued by ASIC to a company registered under the Corporations Act 2001: 9 digits, the last one a check digit. Spaced (102 443 916) and prefixed (ACN 102 443 916) input is accepted and normalized.","example":"102443916"},"arbn":{"type":"string","description":"Australian Registered Body Number (ARBN) issued by ASIC to a registered Australian body or a registered foreign company: 9 digits from the same series as the ACN. Accepted by /v2/company in place of an ACN.","example":"651195041"},"abn":{"type":"string","description":"Australian Business Number (ABN) from the Australian Business Register: 11 digits. A company’s ABN is its ACN behind two check digits. Searchable in /v2/search, which resolves it to the ACN or ARBN to use with /v2/company.","example":"53102443916"}},"description":"Australian company identifiers (AU)"},"KosovoIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"nui":{"type":"string","example":"810485301","description":"Numri Unik Identifikues (NUI): the nine-digit unique identification number issued by ARBK. Older records without a NUI use their eight-digit business number as company.id; no NUI is invented for them."},"numriBiznesit":{"type":"string","example":"70064420","description":"Numri i biznesit: the eight-digit business number, when ARBK records one. Accepted for lookup; a record with a NUI is returned under that NUI."},"numriFiskal":{"type":"string","example":"600178893","description":"Numri fiskal: the fiscal number recorded by ARBK, when present. Not a VAT-registration assertion or a supported lookup key."}},"description":"Kosovo business identifiers (XK)"},"AlbaniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"nipt":{"type":"string","description":"NIPT / NUIS (Numri Unik i Identifikimit të Subjektit) issued by QKB, the National Business Center: one letter, eight digits and one letter (for example K72223031K). The same number identifies the entity with the tax administration. Lowercase and spaced input is accepted and normalized.","example":"K72223031K"}},"description":"Albanian company identifiers (AL)"},"TunisiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"identifiantUnique":{"type":"string","description":"Identifiant unique (المعرف الوحيد) assigned by the Registre National des Entreprises (RNE). Usually seven digits and a control letter, leading zeroes kept (for example 1820260Q), the base of the tax identifier (matricule fiscal). Older records keep other register-issued shapes of five to twelve uppercase letters and digits (for example 552558E, Z932038, 20802PAM).","example":"1820260Q"}},"description":"Tunisian company identifiers (TN)"},"BelizeIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Registration number issued by the Belize Companies and Corporate Affairs Register (BCCAR) when the entity was registered or re-registered on its Online Business Registry System since November 2022: exactly 9 digits, leading zeros included (for example 000013957). Numbers issued before the 2022 re-registration are not accepted.","example":"000013957"}},"description":"Belizean company identifiers (BZ)"},"NicaraguaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"numeroUnico":{"type":"string","description":"Número Único (NAM) of the commercial register: \"MC-\" followed by five to eight letters and digits, with a numeric suffix for a branch (for example MC-XF55W6-4).","example":"MC-XF55KW"},"ruc":{"type":"string","description":"Registro Único de Contribuyente (RUC) as the tax administration lists it: 14 characters, \"J\" and 13 digits for legal persons registered since 2013.","example":"J0310000002975"}},"description":"Nicaraguan company identifiers (NI)"},"AnguillaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Registration number (or deposit number) of the Anguilla Commercial Registry: 1 to 7 digits for entities registered before May 2022 (for example 3618; leading zeros are significant), or a letter followed by 9 digits for later ones (for example A000003757, P000002620, S000003417).","example":"3618"}},"description":"Anguillan company identifiers (AI)"},"MontserratIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"companyNumber":{"type":"string","description":"Company number on the register of companies kept by the Companies & Intellectual Property Office of the Financial Services Commission: the letter L, four digits, a slash and the four-digit year of registration (for example L0034/2025). Every company was re-registered under the Companies Act 2023, so the year is that of the re-registration for older companies.","example":"L0034/2025"}},"description":"Montserrat company identifiers (MS)"},"CuracaoIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Registration number in the Commercial Register of the Curaçao Chamber of Commerce & Industry: digits only (for example 36 or 62987). Branches share the number of the company they belong to.","example":"36"}},"description":"Curaçao company identifiers (CW)"},"MontenegroIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"pib":{"type":"string","description":"PIB (Poreski identifikacioni broj): 8 digits, leading zeros significant, the last a check digit (for example 02289377, 04384725). For a legal entity it is also its matični broj. Assigned on registration in the Central Register of Business and Other Entities (CRPS).","example":"02289377"},"registarskiBroj":{"type":"string","description":"Registarski broj: the CRPS registration number, a register book number, a hyphen and a 7- or 8-digit number (for example 4-0000618). The change counter the register prints after it (/071) is not part of the number.","example":"4-0000618"}},"description":"Montenegrin company identifiers (ME)"},"IsraelIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"corporationNumber":{"type":"string","description":"Corporation number (מספר תאגיד) issued by the Israeli Corporations Authority: 9 digits. Companies are numbered from the 51, 52 and 56 series (the company number, ח.פ.), partnerships from the 53, 54 and 55 series. Hyphenated (52-001395-4) and prefixed (ח.פ. 520013954) input is accepted and normalized.","example":"520013954"}},"description":"Israeli company identifiers (IL)"},"NorthMacedoniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"embs":{"type":"string","description":"EMBS (Единствен матичен број на субјектот), the 7-digit registration number the Central Registry of North Macedonia assigns, its last digit a check digit (for example 4065573).","example":"4065573"}},"description":"North Macedonian company identifiers (MK)"},"MoroccoIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"rc":{"type":"string","description":"Numéro du registre de commerce (RC): the number the commercial court gives the company in its local register, digits without leading zeros (for example 214379). Unique only together with the court (tribunal).","example":"214379"},"tribunal":{"type":"string","description":"The commercial court (tribunal) that keeps the RC entry, as OMPIC writes it (for example CASABLANCA).","example":"CASABLANCA"},"ice":{"type":"string","description":"ICE (Identifiant Commun de l’Entreprise): 15 digits, leading zeros kept (for example 000030205000041). National; not every register entry has one.","example":"000030205000041"}},"description":"Moroccan company identifiers (MA)"},"MonacoIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"rci":{"type":"string","description":"RCI (Répertoire du Commerce et de l'Industrie) - Company registration number. Format: 8 characters, 2 digits + an uppercase letter + 5 digits (e.g., \"99S03612\", \"18C21017\", \"80P04049\"); leading zeros are significant. In the records we have seen, S is a commercial company, C a civil company, P a natural person trading in their own name.","example":"99S03612"},"statisticalIdentificationNumber":{"type":"string","description":"NIS (Numéro d'Identification Statistique) - Statistical identification number of the main establishment, issued by IMSEE. Format: 10 characters, the NAF activity code (4 digits + a letter) followed by a 5-digit sequence number (e.g., \"6630Y08763\").","example":"6630Y08763"}},"description":"Identifiers for Monégasque companies (MC)"},"MaltaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Registration Number - Company registration number issued by the Malta Business Registry. Format: an entity-type prefix, a space, then digits (e.g., \"C 2833\", \"P COMM 203\"); former offshore companies are numbered \"OS/<digits>/T\" or \"OS/<digits>/NT\" (e.g., \"OS/1116/NT\").","example":"C 2833"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Available for domestic private and public limited liability companies.","example":"MTROC.C2833"}},"description":"Identifiers for Maltese companies (MT)"},"MauritiusIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"brn":{"type":"string","description":"The CBRD File No.: one letter followed by up to 6 digits, exactly as issued (e.g. C117853, C067923, L153); a zero after the letter is part of the number, not padding. The letter C marks a company and L a limited partnership (limited partnership files have 1 to 3 digits in the register list we have seen). This is the identifier /v2/company accepts. It is distinct from the Business Registration Number (purely numeric, e.g. 125473, or one letter followed by 8 digits, e.g. C07068818), which identifies a business registration rather than the entity; an alphanumeric BRN, or an FSC global-business licence number such as 61811 C1/GBL, resolves to the File No. through /v2/search (a purely numeric BRN does not).","example":"C117853"}},"description":"Identifiers for Mauritian companies (MU)"},"NewCaledoniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"ridet":{"type":"string","description":"RIDET issued by the Institut de la Statistique et des Études Économiques (ISEE) of New Caledonia. Format: 10 digits: a 7-digit RID (the legal entity, assigned by ISEE) followed by a 3-digit ET establishment suffix (the entity's head office is usually, but not always, \"001\"). One RID can have several ET establishments, each with its own avis de situation. Pass all 10 digits, no space or dot.","example":"1505288001"}},"description":"Identifiers for New Caledonia companies (NC)"},"NetherlandsIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"NLNHR.34259528"},"kvk":{"type":"string","description":"KVK (Kamer van Koophandel) - Chamber of Commerce number. Format: 8 digits, leading zeros significant (e.g., \"39086858\"). Issued by the Chamber of Commerce to every entity in the trade register, one per entity.","example":"39086858"},"RSIN":{"type":"string","description":"RSIN (Rechtspersonen en Samenwerkingsverbanden Informatienummer) - Legal Entities and Partnerships Information Number. Format: 9 digits (e.g., \"813454554\"). Assigned at registration in the trade register; sole traders (eenmanszaak) have none. For a legal entity, the VAT number is the RSIN followed by B and a 2-digit subnumber.","example":"813454554"},"VAT":{"type":"string","description":"VAT number (BTW nummer) without NL prefix. Format: 9 digits + B + 2-digit subnumber (e.g., \"813454554B01\"). For a legal entity the 9 digits are its RSIN; for a sole trader they are a separate number. Taken from the trade register extract when it shows one, otherwise built from the RSIN with subnumber B01.","example":"813454554B01"}},"description":"Identifiers for Dutch companies (NL)"},"NorwayIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"NOFOR.923609016"},"organisasjonsnummer":{"type":"string","description":"Organisation Number (Organisasjonsnummer) - Company registration number. Format: 9 digits, no separators, starting with 8 or 9; the last digit is a modulus-11 check digit (e.g., \"923609016\"). Search also accepts it written with spaces or dots (\"923 609 016\", \"923.609.016\"). Issued by: Brønnøysund Register Centre.","example":"923609016"},"VAT":{"type":"string","description":"VAT number (MVA number) - the organisation number suffixed with \"MVA\". Format: 9 digits followed by \"MVA\", no separators (e.g., \"923609016MVA\"). Present only when the company is registered in the VAT register (Merverdiavgiftsregisteret).","example":"923609016MVA"}},"description":"Identifiers for Norwegian companies (NO)"},"PolandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"PLKRS.0000028860"},"krs":{"type":"string","description":"KRS (Krajowy Rejestr Sądowy) - National Court Register number. Format: 10 digits, leading zeros significant (e.g., \"0000028860\"). Search results and company ids carry it with a krs- prefix (e.g., \"krs-0000028860\"). Issued by: National Court Register.","example":"0000028860"},"nip":{"type":"string","description":"NIP (Numer Identyfikacji Podatkowej) - Tax identification number. Format: 10 digits, the last one a check digit (e.g., \"7740001454\"). Sole entrepreneurs are returned by search with the id nip- + NIP. Issued by: Tax Office.","example":"7740001454"},"regon":{"type":"string","description":"REGON (Rejestr Gospodarki Narodowej) - Statistical number. Format: 9 digits for an entity or 14 digits for a local unit, the last one a check digit (e.g., \"610188201\"). Issued by: Central Statistical Office.","example":"610188201"},"VAT":{"type":"string","description":"VAT number (Numer Identyfikacji Podatkowej dla VAT) without PL prefix. In Poland, the VAT number equals the NIP. Format: 10 digits (same as NIP).","example":"7740001454"}},"description":"Identifiers for Polish companies (PL)"},"PortugalIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms: PTIRNMJ. followed by the 9-digit NIF.","example":"PTIRNMJ.517116022"},"NIF":{"type":"string","description":"NIF (Número de Identificação Fiscal) - Tax identification number. Format: 9 digits, the last a mod-11 check digit. A legal person (NIPC) starts with 5, 6, 8 or 9, most companies with 5; a sole entrepreneur uses a personal NIF starting with 1 to 4. Issued by: the Registo Nacional de Pessoas Coletivas (RNPC) for a NIPC, the Autoridade Tributária e Aduaneira (Tax and Customs Authority) otherwise.","example":"517116022"},"VAT":{"type":"string","description":"VAT number (Número de Identificação de Valor Acrescentado) without PT prefix. In Portugal, the VAT number equals the NIF. Format: 9 digits (same as NIF).","example":"517116022"}},"description":"Identifiers for Portuguese companies (PT)"},"RomaniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"cui":{"type":"string","description":"CUI (Cod Unic de Înregistrare) - fiscal identification code, never changed for the life of the company. Format: 2 to 10 digits (e.g., \"37246510\"). Search results carry the registration number as the company id, not the CUI.","example":"37246510"},"registrationNumber":{"type":"string","description":"Registration Number (Număr de ordine în Registrul Comerțului), the company id search returns. Format: either a letter + county code + sequence + year separated by slashes (e.g., \"J40/8232/2024\", \"F16/655/2004\"), or 14 characters: a letter + 4-digit year + 6-digit sequence + 2-digit county code (00 since 26 July 2024) + a check digit (e.g., \"J2017003749401\"). J legal entities, F authorised individuals and sole traders, C cooperatives.","example":"J2017003749401"},"VAT":{"type":"string","description":"VAT number (Cod de TVA) without the RO prefix: the CUI, 2 to 10 digits. Returned only when VIES confirms the company is registered for VAT.","example":"37246510"},"euid":{"type":"string","description":"EUID (European Unique Identifier). Format: ROONRC. + the registration number in the form the register currently holds (e.g., \"ROONRC.J2017003749401\", \"ROONRC.J40/8232/2024\"). Issued by: National Trade Register Office (ONRC).","example":"ROONRC.J2017003749401"}},"description":"Identifiers for Romanian companies (RO)"},"SerbiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"mbr":{"type":"string","description":"MBR (Матични број / Matični broj registracije) - Company registration number. Format: 8 digits, leading zeros significant (e.g., \"21837792\", \"07018835\"). Issued by: APR (Agencija za privredne registre — Serbian Business Registers Agency).","example":"21837792"},"taxNumber":{"type":"string","description":"PIB (Порески идентификациони број) - Tax identification number. Format: 9 digits, the last a check digit (ISO 7064 MOD 11,10) (e.g., \"113279163\"). Issued by: Tax Administration of Serbia.","example":"113279163"}},"description":"Identifiers for Serbian companies (RS)"},"SpainIdentifiersDTO":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"nif":{"type":"string","description":"NIF/CIF (Número de Identificación Fiscal). A legal entity's NIF is 9 characters: a letter for the legal form, 7 digits, then a check character that is a digit or a letter (e.g. \"A82511361\"). A natural person's NIF (DNI) is 8 digits followed by a check letter (e.g. \"12345678Z\"). Returned as the register records it, which in rare records means a NIF with a character missing (e.g. \"A5859731\").","example":"A82511361"},"VAT":{"type":"string","description":"VAT number (IVA) without ES prefix. In Spain, this equals the NIF.","example":"A82511361"},"euid":{"type":"string","description":"EUID (European Unique Identifier) — the cross-EU company identifier from the Business Registers Interconnection System (BRIS). ES, a 5-digit register code, a dot, then a 9-digit number with leading zeros. Returned when published in the open data extract.","example":"ES07017.000230803"},"hoja":{"type":"string","description":"Hoja registral: the Mercantile Register sheet reference (a province code of 1 or 2 letters, a hyphen, then the sheet number, e.g. M-213521 or BI-65606). This is the value LEI/GLEIF records publish as the Spanish \"Registration Authority Entity ID\" (there with a trailing control digit). Returned when the company is matched in the BORME gazette.","example":"M-213521"},"NIF":{"type":"string","deprecated":true,"description":"Deprecated legacy alias of `nif` — use `nif`. Emitted until 2026-09-01.","example":"A82511361"}}},"SwedenIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier, derived for supported domestic company forms from the national register number.","example":"SEBOLREG.5560360793"},"organizationNumber":{"type":"string","description":"Organization Number (Organisationsnummer) - Company registration number. Format: 10 digits, returned without a separator (e.g., \"5560360793\"); also accepted as input with a hyphen after the sixth digit (\"556036-0793\"). The third digit is 2 or higher; the last digit is a Luhn check digit. Issued by: Swedish Companies Registration Office (Bolagsverket).","example":"5560360793"},"VAT":{"type":"string","description":"VAT number (Momsregistreringsnummer) without SE prefix. Format: 12 digits: the organisation number followed by \"01\" (e.g., \"556036079301\" from organisation number \"5560360793\"), or for a sole trader the personal identity number without its two century digits, followed by \"01\".","example":"556036079301"},"personalIdentityNumber":{"type":"string","description":"Personal Identity Number (Personnummer) — Used as the registration identifier for Swedish sole traders (enskild firma). Format: 12 digits YYYYMMDDNNNN, returned without a separator; also accepted as input hyphenated as YYYYMMDD-NNNN. Issued by Skatteverket; accepted by Bolagsverket as the business identifier for sole traders.","example":"196405250314"}},"description":"Identifiers for Swedish companies (SE)"},"SlovakiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Returned for eligible s.r.o. and a.s. companies confirmed in the Commercial Register.","example":"SKORSR.35763469"},"ico":{"type":"string","description":"IČO (Identifikačné číslo organizácie) - Company identification number. Format: 8 digits, leading zeros significant; the eighth digit is a check digit (e.g., \"35763469\"). Issued by: Slovak Statistical Office.","example":"35763469"}},"description":"Identifiers for Slovak companies (SK)"},"SloveniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Returned for eligible d.o.o. and d.d. companies; sole traders and establishments are excluded.","example":"SIPRS.5025796000"},"registrationNumber":{"type":"string","description":"Matična številka (Registration number). Format: 10 digits (e.g., \"5025796000\"): a 7-digit entity number ending in a check digit, then 000 for the entity itself or the sequence number of one of its branches. Issued by: AJPES (Slovenian Business Register).","example":"5025796000"},"taxNumber":{"type":"string","description":"Davčna številka (Tax number). Format: 8 digits (e.g., \"80267432\"). Issued by: Financial Administration of the Republic of Slovenia (FURS).","example":"80267432"},"VAT":{"type":"string","description":"VAT identification number. Format: SI + 8 digits (e.g., \"SI80267432\"). Issued by: Financial Administration of the Republic of Slovenia (FURS).","example":"SI80267432"}},"description":"Identifiers for Slovenian companies (SI)"},"UnitedKingdomIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"companiesHouseNumber":{"type":"string","description":"Companies House Number - the company registration number issued by Companies House. Format: always 8 characters, uppercase letters and digits, leading zeros significant: 8 digits (e.g. \"00445790\"), a 2-letter prefix and 6 digits (e.g. \"SC132832\", \"OC303675\", \"FC027926\"), or occasionally another arrangement of letters (e.g. \"R0000390\", \"IP03289R\"). This is the single canonical UK company-number key: it is used for the queried company and for every related company (officers, persons with significant control, and reconstructed shareholders).","example":"00445790"}},"description":"Identifiers for UK companies (GB)"},"BVIIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"companyNumber":{"type":"string","description":"Company Number - registration number issued by the BVI Financial Services Commission. Format: digits only, no leading zeros (5 to 7 digits in the records we have seen, e.g. \"587145\", \"1567724\"); older local companies carry an \"L\" prefix (e.g. \"L658\").","example":"587145"}},"description":"Identifiers for BVI companies (VG)"},"BosniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"mbs":{"type":"string","description":"MBS (Matični broj subjekta) - Court register number, exactly as the register publishes it. Format: hyphen-separated digit groups: `NN-0C-XXXX-YY` (e.g. \"65-01-0620-08\"), two groups (e.g. \"1-369\", \"1-12440\"), three groups ending in -00 (e.g. \"3-35-00\"), or, on a few older Republika Srpska records, `RU-` + three groups (e.g. \"RU-1-1852-00\"). Issued by: the registration court. NOT nationally unique: each of the three BiH registers numbers independently, so the same MBS can identify different companies in different registers. Use `company.id`, which is register-qualified (\"FBiH 65-01-0620-08\", \"Brčko 1-369\", \"RS 3-35-00 4402503100008\"), when you need a unique key.","example":"65-01-0620-08"},"jib":{"type":"string","description":"JIB / IDU (Jedinstveni identifikacijski broj) - Unique identification number. Format: 13 digits (e.g., \"4402503100008\"). Issued by: UINO (Indirect Taxation Authority of BiH), at state level. Nationally unique and stable across register moves, which makes it the reliable key for cross-referencing an entity between the three registers.","example":"4402503100008"}},"description":"Identifiers for Bosnian companies (BA)"},"BulgariaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Returned for eligible OOD, EOOD, AD and EAD companies in the Commercial Register.","example":"BGCOMREG.831094393"},"uic":{"type":"string","description":"EIK / UIC (Единен идентификационен код) - the Bulgarian company registration number. Format: 9 digits for a company (e.g., \"208582266\"); 13 digits for a branch (e.g., \"0006940370018\"). Issued by: Registry Agency (Агенция по вписванията). Also serves as the national tax identifier.","example":"208582266"},"VAT":{"type":"string","description":"VAT number without the BG prefix. Format: 9 digits, identical to the UIC. Returned when the entity is registered for VAT and the number is validated against VIES.","example":"208582266"}},"description":"Identifiers for Bulgarian companies (BG)"},"GreeceIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier derived from the confirmed GEMI identity for supported domestic AE and IKE companies.","example":"ELGEMI.000031301000"},"gemiNumber":{"type":"string","description":"Αριθμός ΓΕΜΗ - GEMI number. Format: up to 12 digits, returned without leading zeros (e.g., \"31301000\", \"101933403000\"); the full 12-digit form with leading zeros is the same number. Issued by: General Commercial Register (ΓΕΜΗ / GEMI).","example":"31301000"},"vatNumber":{"type":"string","description":"VAT number (ΑΦΜ / AFM) with the EL prefix. Format: EL followed by 9 digits, leading zeros significant, the last digit a check digit (e.g., \"EL093808863\"). The company request also accepts this value for a company that is in GEMI and answers under its GEMI Number.","example":"EL093808863"},"taxNumber":{"type":"string","description":"Tax registration number (ΑΦΜ / AFM) without the EL prefix. Format: 9 digits, leading zeros significant, the last digit a check digit (e.g., \"093808863\").","example":"093808863"}},"description":"Identifiers for Greek companies (GR)"},"LithuaniaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"euid":{"type":"string","description":"European Unique Identifier (EUID). Returned for UAB and AB companies with a register-confirmed legal-entity code and legal form.","example":"LTJAR.123033512"},"jaKodas":{"type":"string","description":"Juridinio asmens kodas (legal-entity code) - the registration number assigned by the Register of Legal Entities. Format: 9 digits (e.g., \"123033512\"). Issued by: Registrų centras (State Enterprise Centre of Registers).","example":"123033512"}},"description":"Identifiers for Lithuanian companies (LT)"},"MoldovaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"idno":{"type":"string","description":"IDNO - Numărul de identificare de stat (state identification number). Format: 13 digits (e.g., \"1003603151655\"), the last a check digit (first 12 digits weighted 7, 3, 1 repeating, sum modulo 10). A few old records in the open data carry a shorter number (e.g., \"10013\"). Issued by: Public Services Agency (Agenția Servicii Publice).","example":"1003603151655"},"md_synthetic":{"type":"string","description":"Synthetic fallback identifier assigned by Topograph when an entity in the register's open data has no published IDNO. Format: md_noidno_ + 12 lowercase hexadecimal characters (e.g., \"md_noidno_e251fab5710b\"). Used in place of \"idno\" for those records, and is also their company id.","example":"md_noidno_e251fab5710b"}},"description":"Identifiers for Moldovan companies (MD)"},"RussiaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"ogrn":{"type":"string","description":"OGRN - Primary State Registration Number for legal entities. Format: 13 digits starting with 1 or 5, the last one a check digit (e.g., \"1027700035769\"). Issued by: Federal Tax Service (EGRUL).","example":"1027700035769"},"ogrnip":{"type":"string","description":"OGRNIP - Primary State Registration Number for individual entrepreneurs. Format: 15 digits starting with 3, the last one a check digit (e.g., \"318028000064743\"). Issued by: Federal Tax Service (EGRIP).","example":"318028000064743"},"inn":{"type":"string","description":"INN - Taxpayer Identification Number. Format: 10 digits for legal entities (the last one a check digit, e.g., \"7708004767\"), 12 digits for sole entrepreneurs and individuals (the last two check digits). Leading zeros are significant. Issued by: Federal Tax Service.","example":"7708004767"},"kpp":{"type":"string","description":"KPP - Tax Registration Reason Code (subdivision assignment code). Format: 9 characters, usually all digits (e.g., \"770801001\"); the 5th and 6th may be uppercase Latin letters. Assigned per registration with the tax authority. Not applicable to sole entrepreneurs.","example":"770801001"}},"description":"Identifiers for Russian companies (RU)"},"SingaporeIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"uen":{"type":"string","description":"UEN - Unique Entity Number. Format: 9 or 10 characters ending in a check letter: 8 digits + letter for businesses (e.g., \"52898560D\"), year + 5 digits + letter for local companies (e.g., \"201932822G\"), or T/S/R + 2-digit year + 2-character entity type + 4 digits + letter for other entities (e.g., \"T17LL0584B\"). Issued by: ACRA (Accounting and Corporate Regulatory Authority).","example":"201932822G"}},"description":"Identifiers for Singapore companies (SG)"},"UkraineIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"edrpou":{"type":"string","description":"EDRPOU code - the registration code for legal entities and foreign subdivisions. Format: 8 digits, leading zeros significant, the last one a check digit (e.g., \"00113968\"). Issued by: EDR (Unified State Register of Ukraine).","example":"00113968"},"record":{"type":"string","description":"Record number - the EDR open-data record number for sole entrepreneurs (FOP). Format: digits only, 7 or 8 in the records we have seen (e.g., \"10693269\"). The company id is this number with a FOP- prefix (e.g., \"FOP-10693269\").","example":"10693269"}},"description":"Identifiers for Ukrainian companies (UA)"},"CaymanIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Company Registration Number issued by the Cayman Islands General Registry (Registrar of Companies), as printed on the Search Report and the Certificate of Incorporation: usually digits (e.g. \"320834\"), sometimes quoted with a two-letter prefix (e.g. \"CR-72229\"). Not usable as a query: company.id and search results carry the entity name encoded in base64 instead.","example":"320834"}},"description":"Identifiers for Cayman Islands companies (KY)"},"GibraltarIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"companyNumber":{"type":"string","description":"Company registration number issued by Companies House Gibraltar (\"Reg. Number\" / \"Incorporation No.\"): digits only, sequential, of variable length (e.g. \"37905\", \"91225\").","example":"37905"},"reid":{"type":"string","description":"Registered Entity Identification number shown by Companies House Gibraltar on the company record and the Company Profile: \"GICO.\" followed by the company number, a hyphen and two check digits (e.g. \"GICO.37905-27\").","example":"GICO.37905-27"}},"description":"Identifiers for Gibraltar companies (GI)"},"MarshallIslandsIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"entityNumber":{"type":"string","description":"Entity Number assigned by the Republic of the Marshall Islands corporate register (operated by International Registries, Inc.). Digits only, no leading zeros (4 to 6 digits in the records we have seen, e.g. \"35087\", \"127599\"). Shown on the register entity-search detail page and the Non-Resident Entity Report.","example":"127599"}},"description":"Identifiers for Marshall Islands entities (MH)"},"CanadaFederalIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"corporationNumber":{"type":"string","description":"Corporation number assigned by Corporations Canada. Format: digits only, no leading zero, 4 to 8 digits in the records we have seen (e.g. \"8660115\", \"15544106\"). The register displays it with a hyphen before the last digit (\"866011-5\"); /v2/company accepts both forms.","example":"8660115"},"businessNumber":{"type":"string","description":"Business Number (BN), the 9-digit federal business identifier issued by the Canada Revenue Agency (e.g. \"835752437\"). Searchable with /v2/search, which resolves it to the corporation number. A Business Number can be shared by several corporations (an amalgamated corporation keeps one of its predecessors' numbers), so it is not a /v2/company identifier.","example":"835752437"}},"description":"Identifiers for Canadian federal corporations (CA-FED), kept by Corporations Canada"},"NewZealandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"nzbn":{"type":"string","description":"New Zealand Business Number (NZBN). Format: 13 digits starting with 9429, the last digit a GS1 check digit (e.g. \"9429036794195\"). Every registered entity has one: companies, overseas companies, limited partnerships, incorporated societies, charitable trusts, sole traders and partnerships. This is the identifier /v2/company accepts.","example":"9429036794195"},"companyNumber":{"type":"string","description":"Company number assigned by the New Zealand Companies Office to companies and overseas companies. Format: digits only, 6 to 7 digits in the records we have seen (e.g. \"1157956\"). Returned for companies only. Searchable with /v2/search, which resolves it to the NZBN to use with /v2/company.","example":"1157956"},"gstNumber":{"type":"string","description":"Goods and Services Tax (GST) number, the Inland Revenue number under which the entity is registered for GST. Format: 8 or 9 digits as the register prints it, with hyphens (e.g. \"063-941-905\"). Returned only when the entity chose to publish it on the New Zealand Business Number register.","example":"063-941-905"}},"description":"Identifiers for New Zealand entities, kept by the New Zealand Business Number register and the Companies Office"},"ThailandIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"juristicId":{"type":"string","description":"13 digits, including leading zeros","example":"0107536000374"}},"description":"Thailand company identifiers (TH)"},"MongoliaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"regnum":{"type":"string","description":"7 to 10 digits, including leading zeros: 7 for domestic entities in the records we have seen, 8 or 10 for foreign representative offices","example":"2693321"}},"description":"Mongolia company identifiers (MN)"},"MaldivesIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"registrationNumber":{"type":"string","description":"Letter prefix and digits, sometimes separated by a hyphen and followed by a slash and year; for example C-0449/2014 and SP38202026","example":"C-0449/2014"}},"description":"Maldives company identifiers (MV)"},"BahrainIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"crNumber":{"type":"string","description":"Commercial registration number followed by a hyphen and branch number","example":"269-2"}},"description":"Bahrain company identifiers (BH)"},"SouthKoreaIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"beobinDeungnokBeonho":{"type":"string","description":"13-digit corporate registration number (법인등록번호), preserving leading zeros","example":"1301110006246"},"saeopjaDeungnokBeonho":{"type":"string","description":"Ten-digit business registration number (사업자등록번호) when DART publishes it."}},"description":"SouthKorea company identifiers (KR)"},"TaiwanIdentifiers":{"type":"object","properties":{"lei":{"type":"string","description":"Legal Entity Identifier from GLEIF, returned when an existing company identifier uniquely matches a GLEIF registration or validation reference. Absent when no unambiguous identifier match is available. Lapsed and retired LEIs can be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78","pattern":"^[A-Z0-9]{18}[0-9]{2}$"},"ubn":{"type":"string","description":"Unified Business Number (統一編號, UBN). Format: 8 digits, leading zeros significant (e.g. \"22099131\"; numbers issued since late 2023 start with 00, e.g. \"00007160\"), or a capital letter followed by 7 digits on registrations older than the number (e.g. \"A0004352\"). Some numbers fail the Ministry of Finance check digit and are still valid. Every company, foreign company registration, sole proprietorship and partnership has one. This is the identifier /v2/company accepts.","example":"22099131"}},"description":"Identifiers for Taiwanese entities, kept by the company register of the Ministry of Economic Affairs and the business registers of the local governments"},"MatchType":{"type":"string","enum":["id","exactLegalName","partialId","default"],"description":"The type of match that produced this result. \"id\" means a guaranteed 1:1 match from an ID-based search (e.g., VAT number, CCIAA+REA). \"exactLegalName\" means the legal name exactly matches the search query. \"partialId\" means matched by a partial identifier that is not guaranteed unique (e.g., REA without CCIAA). \"default\" is used when the exact matching criteria is unknown. Results are ordered: id > exactLegalName > partialId > default."},"MatchReason":{"type":"object","properties":{"matchType":{"description":"The type of match that produced this result. \"id\" means a guaranteed 1:1 match from an ID-based search (e.g., VAT number, CCIAA+REA). \"exactLegalName\" means the legal name exactly matches the search query. \"partialId\" means matched by a partial identifier that is not guaranteed unique (e.g., REA without CCIAA). \"default\" is used when the exact matching criteria is unknown. Results are ordered: id > exactLegalName > partialId > default.","example":"id","allOf":[{"$ref":"#/components/schemas/MatchType"}]},"identifier":{"description":"The identifier that matched this result. Present when matchType is \"id\" or \"partialId\". Shows which identifier type and value were used to find this company.","anyOf":[{"$ref":"#/components/schemas/JapanIdentifiers","title":"JP"},{"$ref":"#/components/schemas/AntiguaBarbudaIdentifiers","title":"AG"},{"$ref":"#/components/schemas/ItalyIdentifiers","title":"IT"},{"$ref":"#/components/schemas/FranceIdentifiers","title":"FR"},{"$ref":"#/components/schemas/FrenchPolynesiaIdentifiers","title":"PF"},{"$ref":"#/components/schemas/AustriaIdentifiers","title":"AT"},{"$ref":"#/components/schemas/BelgiumIdentifiers","title":"BE"},{"$ref":"#/components/schemas/BrazilIdentifiers","title":"BR"},{"$ref":"#/components/schemas/SwitzerlandIdentifiers","title":"CH"},{"$ref":"#/components/schemas/ChinaIdentifiers","title":"CN"},{"$ref":"#/components/schemas/CyprusIdentifiers","title":"CY"},{"$ref":"#/components/schemas/CzechiaIdentifiers","title":"CZ"},{"$ref":"#/components/schemas/GermanyIdentifiers","title":"DE"},{"$ref":"#/components/schemas/DenmarkIdentifiers","title":"DK"},{"$ref":"#/components/schemas/EstoniaIdentifiers","title":"EE"},{"$ref":"#/components/schemas/FaroeIslandsIdentifiers","title":"FO"},{"$ref":"#/components/schemas/PhilippinesIdentifiers","title":"PH"},{"$ref":"#/components/schemas/FinlandIdentifiers","title":"FI"},{"$ref":"#/components/schemas/GuernseyIdentifiers","title":"GG"},{"$ref":"#/components/schemas/HongKongIdentifiers","title":"HK"},{"$ref":"#/components/schemas/CroatiaIdentifiers","title":"HR"},{"$ref":"#/components/schemas/HungaryIdentifiers","title":"HU"},{"$ref":"#/components/schemas/IcelandIdentifiers","title":"IS"},{"$ref":"#/components/schemas/IrelandIdentifiers","title":"IE"},{"$ref":"#/components/schemas/IsleOfManIdentifiers","title":"IM"},{"$ref":"#/components/schemas/JerseyIdentifiers","title":"JE"},{"$ref":"#/components/schemas/LiechtensteinIdentifiers","title":"LI"},{"$ref":"#/components/schemas/LuxembourgIdentifiers","title":"LU"},{"$ref":"#/components/schemas/LatviaIdentifiers","title":"LV"},{"$ref":"#/components/schemas/PanamaIdentifiers","title":"PA"},{"$ref":"#/components/schemas/HondurasIdentifiers","title":"HN"},{"$ref":"#/components/schemas/MexicoIdentifiers","title":"MX"},{"$ref":"#/components/schemas/ColombiaIdentifiers","title":"CO"},{"$ref":"#/components/schemas/EcuadorIdentifiers","title":"EC"},{"$ref":"#/components/schemas/BermudaIdentifiers","title":"BM"},{"$ref":"#/components/schemas/ArgentinaIdentifiers","title":"AR"},{"$ref":"#/components/schemas/ChileIdentifiers","title":"CL"},{"$ref":"#/components/schemas/UruguayIdentifiers","title":"UY"},{"$ref":"#/components/schemas/ParaguayIdentifiers","title":"PY"},{"$ref":"#/components/schemas/BoliviaIdentifiers","title":"BO"},{"$ref":"#/components/schemas/DominicanRepublicIdentifiers","title":"DO"},{"$ref":"#/components/schemas/AustraliaIdentifiers","title":"AU"},{"$ref":"#/components/schemas/KosovoIdentifiers","title":"XK"},{"$ref":"#/components/schemas/AlbaniaIdentifiers","title":"AL"},{"$ref":"#/components/schemas/TunisiaIdentifiers","title":"TN"},{"$ref":"#/components/schemas/BelizeIdentifiers","title":"BZ"},{"$ref":"#/components/schemas/NicaraguaIdentifiers","title":"NI"},{"$ref":"#/components/schemas/AnguillaIdentifiers","title":"AI"},{"$ref":"#/components/schemas/MontserratIdentifiers","title":"MS"},{"$ref":"#/components/schemas/CuracaoIdentifiers","title":"CW"},{"$ref":"#/components/schemas/MontenegroIdentifiers","title":"ME"},{"$ref":"#/components/schemas/IsraelIdentifiers","title":"IL"},{"$ref":"#/components/schemas/NorthMacedoniaIdentifiers","title":"MK"},{"$ref":"#/components/schemas/MoroccoIdentifiers","title":"MA"},{"$ref":"#/components/schemas/MonacoIdentifiers","title":"MC"},{"$ref":"#/components/schemas/MaltaIdentifiers","title":"MT"},{"$ref":"#/components/schemas/MauritiusIdentifiers","title":"MU"},{"$ref":"#/components/schemas/NewCaledoniaIdentifiers","title":"NC"},{"$ref":"#/components/schemas/NetherlandsIdentifiers","title":"NL"},{"$ref":"#/components/schemas/NorwayIdentifiers","title":"NO"},{"$ref":"#/components/schemas/PolandIdentifiers","title":"PL"},{"$ref":"#/components/schemas/PortugalIdentifiers","title":"PT"},{"$ref":"#/components/schemas/RomaniaIdentifiers","title":"RO"},{"$ref":"#/components/schemas/SerbiaIdentifiers","title":"RS"},{"$ref":"#/components/schemas/SwedenIdentifiers","title":"SE"},{"$ref":"#/components/schemas/SlovakiaIdentifiers","title":"SK"},{"$ref":"#/components/schemas/SloveniaIdentifiers","title":"SI"},{"$ref":"#/components/schemas/SpainIdentifiersDTO","title":"ES"},{"$ref":"#/components/schemas/UnitedKingdomIdentifiers","title":"GB"},{"$ref":"#/components/schemas/BVIIdentifiers","title":"VG"},{"$ref":"#/components/schemas/BosniaIdentifiers","title":"BA"},{"$ref":"#/components/schemas/BulgariaIdentifiers","title":"BG"},{"$ref":"#/components/schemas/GreeceIdentifiers","title":"GR"},{"$ref":"#/components/schemas/LithuaniaIdentifiers","title":"LT"},{"$ref":"#/components/schemas/MoldovaIdentifiers","title":"MD"},{"$ref":"#/components/schemas/RussiaIdentifiers","title":"RU"},{"$ref":"#/components/schemas/SingaporeIdentifiers","title":"SG"},{"$ref":"#/components/schemas/UkraineIdentifiers","title":"UA"},{"$ref":"#/components/schemas/CaymanIdentifiers","title":"KY"},{"$ref":"#/components/schemas/GibraltarIdentifiers","title":"GI"},{"$ref":"#/components/schemas/MarshallIslandsIdentifiers","title":"MH"},{"$ref":"#/components/schemas/CanadaFederalIdentifiers","title":"CA-FED"},{"$ref":"#/components/schemas/NewZealandIdentifiers","title":"NZ"},{"$ref":"#/components/schemas/ThailandIdentifiers","title":"TH"},{"$ref":"#/components/schemas/MongoliaIdentifiers","title":"MN"},{"$ref":"#/components/schemas/MaldivesIdentifiers","title":"MV"},{"$ref":"#/components/schemas/BahrainIdentifiers","title":"BH"},{"$ref":"#/components/schemas/SouthKoreaIdentifiers","title":"KR"},{"$ref":"#/components/schemas/TaiwanIdentifiers","title":"TW"},{"title":"US-AK","type":"object","properties":{"entityNumber":{"type":"string","description":"Alaska Entity Number: 1 to 8 digits for entities in the current numbering (e.g. 10310827, 131088). Some records carry a letter suffix after the digits; observed suffixes include D, F, H, PD and PF (e.g. 72D, 476F, 4109H, 54PD). Preserve the suffix; the list is not exhaustive. Primary identifier assigned by the Alaska Division of Corporations, Business and Professional Licensing (CBPL).","example":"10310827"},"licenseNumber":{"type":"string","description":"Alaska Business License Number: 1 to 7 digits (e.g. 2200860). This is the value returned in company.identifiers.licenseNumber. The company id of a license holder is the license number prefixed with AKBL- (e.g. AKBL-2200860). Primary identifier for sole proprietors and other business-license holders not present in the corporations register. Search results and company.id carry the AKBL- form, which keeps license numbers apart from entity numbers: use it as the id on /v2/company. The bare license number is accepted too, but a bare number is first read as an entity number. Corporation extracts and filings are not available for AKBL- license records.","example":"2200860"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-AL","type":"object","properties":{"entityId":{"type":"string","description":"Entity ID Number: 9 digits, no separators, leading zeros significant (e.g. 000358845, 001226798). The Secretary of State moved from 6-digit to 9-digit Entity IDs by adding three leading zeros to existing numbers, so older entities start with 000. The register displays the number with dashes (000-358-845). Input with dashes or without the leading zeros (358845) is also accepted. Primary identifier assigned by the Alabama Secretary of State Business Entities Division (ARC-SOS). Responses always return the 9-digit form without dashes.","example":"000358845"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-AR","type":"object","properties":{"filingNumber":{"type":"string","description":"Arkansas Filing Number: 8 or 9 digits. Observed filing numbers include 100, 200 and 811 prefixes (e.g. 200000034); the supported numeric format also admits 800 prefixes. Do not restrict validation to a list of prefixes. Primary identifier assigned by the Arkansas Secretary of State Business & Commercial Services register.","example":"811388512"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-AZ","type":"object","properties":{"entityNumber":{"type":"string","description":"Arizona Entity Number: Either 7 or 8 digits with no prefix, leading zeros significant (e.g. 01138954, 1864605, 23906030), or one letter followed by 7 or 8 digits (e.g. L10176615, F00005784, R18260883, N16431384, M0900455). Observed prefixes include F, L, M, N, P and R (e.g. P15768203); this is not an exhaustive prefix list. Primary identifier assigned by the Arizona Corporation Commission. The letter, when present, is part of the number: pass the identifier exactly as a search result returns it, without restricting letters to a fixed list. Secretary of State trade-name and trademark registrations are a separate namespace; their numbers are not interchangeable with ACC entity numbers and are not offered as a separate lookup.","example":"R18260883"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-CA","type":"object","properties":{"entityNumber":{"type":"string","description":"California Entity Number: Digits only, or B followed by 11 digits, returned without the C the register writes in front of corporation numbers and without leading zeros. Corporations: up to 7 digits (e.g. 806592, 3731484, which the register writes C0806592 and C3731484). LLCs and limited partnerships registered before 2025: 12 digits (e.g. 201806210004). Corporations, LLCs and limited partnerships registered since 2025: B followed by 11 digits (e.g. B20260142586); the B is part of the number. Primary identifier assigned by the California Secretary of State, visible on the bizfileOnline portal. Corporation numbers are accepted with or without the C prefix and leading zeros. Keep the B on numbers that have one.","example":"806592"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-CO","type":"object","properties":{"entityId":{"type":"string","description":"Colorado SOS Entity ID: Digits only, no separators. Usually 11 digits (e.g. 19931121425, 20248299164); the historical entity 1923178226 has 10 digits on both the live register and its open data. Both lengths are accepted unchanged. Primary identifier assigned by the Colorado Secretary of State business database, shown as the ID number on the entity summary page.","example":"19931121425"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-CT","type":"object","properties":{"accountNumber":{"type":"string","description":"Account Number: 7 digits, no separators, leading zeros significant (e.g. 0668349, 3453337). Primary identifier assigned by the Connecticut Secretary of the State, and the value returned as `company.id`. The composite ALEI form and a number without its leading zeros (668349) are also accepted on input.","example":"0668349"},"alei":{"type":"string","description":"ALEI (Administrative Legal Entity Identifier): Composite string US-CT.BER: followed by the 7-digit account number, leading zeros kept (e.g. US-CT.BER:0668349) The account number carrying its register prefix. This is the form shown on the public Business Records Search portal. Returned alongside the bare account number in every profile response, and accepted interchangeably on input.","example":"US-CT.BER:0668349"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-DC","type":"object","properties":{"fileNumber":{"type":"string","description":"DC File Number: The file number exactly as the register issued it, uppercase, in one of these shapes: 1 to 6 digits, leading zeros significant (e.g. 571294, 004285); one letter followed by 4 to 6 digits (e.g. L14177, C013788); one letter followed by 10 or 11 digits (e.g. L00005531281, L0000053226); two letters followed by 10 digits (e.g. AC0004848765); and, for recently registered entities, US-DC- followed by two letters and 9 digits (e.g. US-DC-LL082600020, US-DC-FN042602087). In the US-DC- form the two letters match the entity type in the records we have seen: LL domestic LLC, CO domestic corporation, NP domestic nonprofit, LP domestic limited partnership, ST domestic statutory trust, GC and LC cooperative associations, FN any foreign entity. In the older lettered forms the letter does not reliably give the entity type (many foreign LLCs carry a C number). A handful of old records carry irregular values such as 951448-4164482. Primary identifier assigned by the DC Department of Licensing and Consumer Protection. Pass it exactly as a search result returns it, including leading zeros and the US-DC- prefix where present.","example":"L00005531281"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-DE","type":"object","properties":{"fileNumber":{"type":"string","description":"Delaware File Number: Digits only, no separators and no leading zeros. In the records we have seen: 4 to 8 digits, most often 7 (e.g. 3177627) or 8 (e.g. 10171608), and shorter numbers such as 523608, 23110 or 4305. The Division of Corporations does not publish a fixed length. Primary identifier assigned by the Delaware Division of Corporations at formation. Covers all entity types registered with ICIS eCorp.","example":"3177627"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-FL","type":"object","properties":{"documentNumber":{"type":"string","description":"Document Number: Either 12 or 6 characters. 12 characters: one uppercase letter followed by 11 digits (e.g. P99000001570, L22000252360). 6 characters, on older filings: six digits (e.g. 112252) or one letter followed by five digits (e.g. A17753, G10360). The letter reflects the filing type and period, e.g. P (domestic profit corporation), L (LLC), F (foreign entity); letters in use include A, F, G, H, K, L, M, N, P, S, T and W. Primary identifier assigned by the Florida Division of Corporations. Visible on every Sunbiz entity detail page and used to look up filings on search.sunbiz.org.","example":"P99000001570"},"feiNumber":{"type":"string","description":"FEI / EIN: 9 digits issued by the U.S. Internal Revenue Service. Accepted with or without the standard hyphen (e.g. 59-0324412 or 590324412). Not all entities carry an FEI/EIN on file, so a lookup by this identifier may return no result even for an active entity. Returned in `company.identifiers.feiNumber` as the register stores it, typically with the hyphen.","example":"59-0324412"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-GA","type":"object","properties":{"controlNumber":{"type":"string","description":"Control Number: Up to 8 characters. Recent entities: 8 digits (e.g. 11078964). Older entities: 7 digits with leading zeros (e.g. 0003726), or one letter followed by 6 digits (e.g. H852680, J716207, K404041, A401954). A few legacy records carry \"0\" + a letter + 5 digits (e.g. 0F00549). The letter belongs to an older numbering series and says nothing about whether the entity is domestic or foreign. Primary identifier assigned by the Georgia Secretary of State Corporations Division (eCorp).","example":"H852680"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-HI","type":"object","properties":{"fileNumber":{"type":"string","description":"Hawaii BREG File Number: A number of up to 7 digits with no leading zeros (3 to 6 digits in the records we have seen), followed directly by a two-character suffix of one uppercase letter and one digit, with no space (e.g. 112127D1, 270541C5, 33838F1, 151D1). The suffix is the register's entity-type code, e.g. D1 Domestic Profit Corporation, C5 Domestic Limited Liability Company. The register displays the number with a space before the suffix (112127 D1); both forms are accepted on input. Primary identifier assigned by the Hawaii Business Registration Division (DCCA / BREG). The suffix is part of the identifier: a number sent without it is not recognised. Responses return the form without a space.","example":"112127D1"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-IA","type":"object","properties":{"corpNumber":{"type":"string","description":"Iowa Business Entity Number: 6 digits, numeric only, with leading zeros preserved (e.g. 084726). Primary identifier assigned by the Iowa Secretary of State, Business Services Division.","example":"084726"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-ID","type":"object","properties":{"entityNumber":{"type":"string","description":"Idaho SoS Entity Number: Digits only, up to 10, returned without leading zeros and with no prefix or separators. The records we have seen carry 3 to 7 digits (e.g. 481, 9532, 586619, 3960192). The register also shows the number zero-padded to 10 digits (e.g. 0003960192); that form is accepted too. Primary identifier assigned by the Idaho Secretary of State and shown on its SOSBiz register. Search results and company.id carry it without leading zeros. A number typed into name search is matched as free text, not as an identifier: request the company with it directly.","example":"3960192"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-IL","type":"object","properties":{"fileNumber":{"type":"string","description":"ILSOS File Number: 8 digits, leading zeros included, no separators (e.g. 08142220, 00263028). This is the value returned in company.identifiers.fileNumber. Illinois numbers corporations and LLCs in separate sequences, so one number can belong to two entities. Search results and company.id therefore carry a one-letter prefix that is ours, not the register's: C for an entity on the corporation register (including not-for-profit corporations) and L for an LLC (e.g. C08142220, L02664844). Primary identifier assigned by the Illinois Secretary of State, Department of Business Services. Use the prefixed id from search results on /v2/company. A bare 8-digit number is accepted too, but when it matches both a corporation and an LLC the request is refused and the prefixed form is required.","example":"08142220"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-IN","type":"object","properties":{"entityNumber":{"type":"string","description":"Indiana Business Entity Number: Several formats, by period: 13 to 16 digits (e.g. 2001111900027, 202406111799031); 8 to 12 digits (e.g. 1997051343); a legacy form of 6 digits, then a hyphen or a letter, then 3 digits (e.g. 183025-143, 193046A080); and LP followed by 8 digits for older limited partnerships (e.g. LP93120064). All formats are accepted for search. Primary identifier assigned by the Indiana Secretary of State Business Services Division (BSD). The format reflects the era of formation.","example":"183025-143"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-KS","type":"object","properties":{"businessId":{"type":"string","description":"Kansas SoS Business ID: Numeric, no dashes or spaces. 6 to 8 digits in the records we have seen; none of those sampled IDs had a leading zero (e.g. 602771, 2444669, 10049404). Distinct from the Federal Employer Identification Number (FEIN). Primary identifier assigned by the Kansas Secretary of State Business Services Division. The observed lengths are not an exhaustive register specification. The portal has never issued or echoed an ID with a leading zero; a zero-padded input (e.g. 0602771) resolves to the same entity as its unpadded form (602771). Preserve the returned ID exactly as given; do not pad it to a fixed width.","example":"2444669"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-KY","type":"object","properties":{"organizationNumber":{"type":"string","description":"Kentucky Organization Number: 7 digits, leading zeros included, no prefix or separators (e.g. 0061792, 1255687). A number sent without its leading zeros (e.g. 61792) is padded to 7 digits. Primary identifier assigned by the Kentucky Secretary of State, Business Filings division. An entity and its assumed names share one Organization Number, which resolves to the entity itself.","example":"0061792"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-LA","type":"object","properties":{"charterNumber":{"type":"string","description":"Louisiana Charter Number: 9 characters: 8 digits followed by one uppercase letter, no separators. Leading zeros are part of the number (e.g. 29504510F, 36528934K, 03002150N). Letters in the records we have seen: D, F, K, L, N and X. Primary identifier assigned by the Louisiana Secretary of State, Commercial Division, which documents it as 8 digits plus one letter. Send all 9 characters.","example":"29504510F"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MA","type":"object","properties":{"maSocId":{"type":"string","description":"MA Secretary of the Commonwealth Entity ID: 9 digits, leading zeros included, no separators (e.g. 000804945, 041543470). Some trusts carry the letter T followed by 8 digits instead (observed). Primary identifier assigned by the Massachusetts Secretary of the Commonwealth, Corporations Division, shown on the register as the Identification Number. Send it with its leading zeros.","example":"000804945"},"dlsId":{"type":"string","description":"DLS Synthetic Identifier: 12 lowercase hexadecimal characters (e.g. 19dcdd187b79). Not a register number: it is derived from the entity name and city listed in the annual Corporations Book of the Division of Local Services, so it changes when either changes in a later edition. Returned as the id of name-search results, and accepted as a search query and on /v2/company. Company profiles carry the official maSocId instead: keep that one.","example":"19dcdd187b79"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MD","type":"object","properties":{"departmentId":{"type":"string","description":"SDAT Department ID: One uppercase letter followed by 8 digits, no separators (e.g. D22958060, W05989793, T00371146). SDAT documents that the letter corresponds to the entity type: D (Maryland corporation, stock or non-stock), F (foreign corporation), W (Maryland LLC), Z (foreign LLC), M and P (Maryland and foreign limited partnership), A and E (Maryland and foreign LLP), B and S (Maryland and foreign statutory trust), L (sole proprietorship or general partnership), T (trade name). Primary identifier assigned by the Maryland State Department of Assessments and Taxation (SDAT), served via the Maryland Business Express portal. An entity that converts to another entity type receives a new Department ID. Trade names (T) appear in name search results but the register publishes no company record for them, so they cannot be retrieved on /v2/company.","example":"D22958060"},"businessCode":{"type":"string","description":"SDAT Business Code: Two-digit code followed by a descriptive label (e.g. \"04 ORDINARY BUSINESS - NON-STOCK\") Secondary SDAT classification code published on the entity detail page. Not present for all entities.","example":"04 ORDINARY BUSINESS - NON-STOCK"},"stateOfFormation":{"type":"string","description":"State of formation: Free text, as published by SDAT State where the entity was originally formed. Returned only when the register publishes it.","example":"MARYLAND"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-ME","type":"object","properties":{"charterNumber":{"type":"string","description":"Maine Charter Number: 8 or 9 digits followed by a one- or two-letter entity-type suffix. A two-letter suffix follows the digits directly (e.g. 19970058LP, 202509124DC); a one-letter suffix is preceded by a space (e.g. 19340021 D, 202500963 F). The Secretary of State documents these suffixes: D, B, RR, CP and I (Maine business corporation), F (foreign business corporation), ND and NF (Maine and foreign nonprofit corporation), DC and FC (Maine and foreign LLC), LP and LF (Maine and foreign limited partnership), DP and FP (Maine and foreign LLP). Other suffixes appear in the records we have seen (e.g. GP). Unique, constant identifier assigned by the Maine Secretary of State to each entity. Accepted with or without the space before a one-letter suffix; responses keep the space.","example":"19970058LP"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MI","type":"object","properties":{"miIdNumber":{"type":"string","description":"Michigan LARA Identification Number: 9 digits, no prefix or separators (e.g. 800853791, 801056837, 900145929). Primary identifier assigned by the Michigan Department of Licensing and Regulatory Affairs (LARA) Corporations Division. Printed on every filing and shown on the MiBusiness Registry entity detail page. Michigan assigned these 9-digit numbers in 2017, replacing the older six-character IDs: send the 9-digit number.","example":"800853791"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MN","type":"object","properties":{"fileNumber":{"type":"string","description":"Minnesota File Number: Variable length, digits and uppercase letters, with at most one internal dash. The register documents that a file number may contain dashes and letters; both are part of the number. Recent filings carry a long all-digit number, 12 or 13 digits in the records we have seen (e.g. 631180100027, 1543060200024); the register allows up to 21 characters. Older filings carry shorter numbers: all digits (e.g. 5451, 68758) or letters and digits around a dash (e.g. 11-AA, 1K-1056, 886-NPA, 4V-200). Accepted in any letter case. Primary identifier assigned by the Minnesota Secretary of State (Minnesota Business & Lien System, MBLS). Name search results do not carry it: their id is the MBLS Filing GUID (see filingGuid). A file number is not unique on its own: the register treats file number and business type together as the unique key, and the same number can belong to entities of different types (e.g. 4912 is both an assumed name and a trademark). When a file number matches more than one entity, look the company up by its Filing GUID.","example":"631180100027"},"filingGuid":{"type":"string","description":"MBLS Filing GUID: 36 characters: 32 lowercase hexadecimal digits in groups of 8, 4, 4, 4 and 12, separated by hyphens (e.g. e4d83ed9-ae4b-e211-bc43-001ec94ffe7f). It has the layout of a UUID but does not follow the UUID version rules (the first digit of the third group is e or f in the records we have seen), so validate the pattern, not a UUID version. Accepted in any letter case. Identifier of the entity record on the MBLS portal. It is the id of every name search result and always resolves to a single entity: pass it as the id on /v2/company. Returned in company.identifiers when available and accepted as a search input.","example":"e4d83ed9-ae4b-e211-bc43-001ec94ffe7f"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MO","type":"object","properties":{"entityId":{"type":"string","description":"Missouri Business Identification Number (BIN): Two register forms. Observed prefixed charter numbers have one or two letters followed by 7 to 9 digits (e.g. F00214431, LC1026096, LC014399166, N00024686). The letters are the register filing category: F (for-profit corporation), LC (domestic LLC), FL (foreign LLC), N (non-profit corporation), LP (limited partnership), H (credit union), K (bank), B (benevolent corporation), O (insurance company), X (fictitious name); the list is not closed. Some for-profit corporations carry 8 digits with no prefix, leading zeros included (e.g. 00333672). Search-result ids may also be MOBSD- followed by the numeric portal record number (e.g. MOBSD-551157); this Topograph id is not a BIN. Primary identifier assigned by the Missouri Secretary of State (BSD). Name search returns the charter number for its first results; the others come back under a Topograph id, MOBSD- followed by the register record number (e.g. MOBSD-551157). Send that id to /v2/company as is: the response carries the charter number as company.id. Leading zeros in a BIN are significant. Bare 8-digit numbers are read as BINs, never as portal record numbers; a record number requires MOBSD-.","example":"F00214431"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MS","type":"object","properties":{"businessId":{"type":"string","description":"Business ID: Digits only, no separators and no leading zeros. 6 or 7 digits in the records we have seen (e.g. 104297, 1001743). Unique identifier assigned by the Mississippi Secretary of State to each registered business entity.","example":"104297"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MT","type":"object","properties":{"entityId":{"type":"string","description":"Montana SoS File Number: One or two uppercase letters followed by 6 or 7 digits, no separator, leading zeros included (e.g. F022568, C1548288, RN1064026). In the records we have seen: C (domestic LLC), E (foreign LLC), D (domestic corporation, profit or nonprofit, e.g. D002784, D1137652), F (foreign corporation), L (limited partnership), A (assumed business name) and RN (name reservation); P and N are also in use. The list is not closed. State correspondence may print the number with a hyphen after the letter (D-123456); the API returns it without. Primary identifier assigned by the Montana Secretary of State at entity formation or qualification, published on the biz.sosmt.gov portal as the Filing Number. Pass it without a hyphen, exactly as a search result returns it.","example":"F022568"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NC","type":"object","properties":{"sosId":{"type":"string","description":"SOS ID: Exactly 7 digits, no separators, left-padded with zeros (e.g. 0027238, 3395486). Every id in the records we have seen has 7 digits. Primary identifier assigned by the North Carolina Secretary of State at entity formation or qualification, called the Secretary of State Identification Number (SOSID) on sosnc.gov. Search and company lookups also accept the number without its leading zeros.","example":"0027238"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-ND","type":"object","properties":{"entityId":{"type":"string","description":"SOS Control ID#: Exactly 10 digits, no separators, left-padded with zeros (e.g. 0000071213, 0007382449). Every id in the records we have seen has 10 digits. Primary identifier assigned by the North Dakota Secretary of State at filing time. Unique across all filing types (corporations, LLCs, trade names, trademarks, reserved names). Search and company lookups also accept the number without its leading zeros.","example":"0000071213"},"ndInternalId":{"type":"string","description":"FirstStop Internal ID: Digits only, no padding (e.g. 70993). A different number from the SOS Control ID#: the two cannot be derived from each other. Portal-internal identifier used by the FirstStop system to navigate to the entity detail page. Not a public register identifier.","example":"70993"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NE","type":"object","properties":{"accountNumber":{"type":"string","description":"SOS Account Number: Digits only, no separators. Three lengths in the records we have seen: 7 digits, often starting with zeros that are part of the number (e.g. 0527041, 1274939), 8 digits (e.g. 10214668) and 10 digits (e.g. 2103077754). Primary identifier assigned by the Nebraska Secretary of State, Business Services Division. Pass it exactly as a search result returns it, leading zeros included.","example":"10214668"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NH","type":"object","properties":{"entityId":{"type":"string","description":"NH Business ID: Letters and digits, no separators. Most entities: digits only, variable length, no leading zeros; 5 to 7 digits in the records we have seen (e.g. 39831, 848218, 1026301). Some older corporations: the letter B followed by 5 digits (e.g. B02109), sometimes with a trailing letter (e.g. B55857A). Primary identifier assigned by the New Hampshire Department of State at filing time, also called the Charter Number. Unique across all entity types: corporations, limited liability companies, limited partnerships, trade names and trademarks share the same number space. Pass it exactly as a search result returns it, including every letter of a B-prefixed ID.","example":"848218"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NJ","type":"object","properties":{"entityId":{"type":"string","description":"NJ Entity ID: Exactly 10 digits, no separators. Leading zeros are part of the number: most ids we have seen start with 0 (e.g. 0100307257, 0400276378), some do not (e.g. 6444850000). The register does not accept a shortened form. Primary identifier assigned by the New Jersey Division of Revenue and Enterprise Services (DORES). Used to look up filings on the DORES public portal and to order business records.","example":"0100307257"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NM","type":"object","properties":{"businessId":{"type":"string","description":"NM SOS Business ID: Observed forms, none with separators. Most entities: 3 to 10 digits, where modern IDs are zero-padded to 10 digits and the leading zeros are significant (e.g. 913, 1166917, 0008058504). Many partnerships: a letter prefix followed by 10 digits (e.g. LPD2005092001); prefixes in use are LPD and LPF (limited partnership, domestic and foreign), GPD (general partnership), LLD (limited liability partnership), LLLD and LLLF (limited liability limited partnership, domestic and foreign). Some older limited partnerships: 4 digits followed by NM (e.g. 0806NM). Historical bank records also carry 3 or 4 digits followed by A (e.g. 323A, 2352A). Primary identifier assigned by the New Mexico Secretary of State and published on the register as the Business ID. Pass it exactly as a search result returns it. The register does not resolve the observed NM-suffixed and A-suffixed numbers through its ID search: those records appear in name search results, but company lookup by those IDs and documents are currently unavailable. Trade Register Extracts are available for numeric IDs of 3 to 10 digits and letter-prefixed partnership IDs.","example":"2070134"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NV","type":"object","properties":{"entityNumber":{"type":"string","description":"Entity Number: An uppercase letter prefix, digits, a hyphen and a numeric suffix, no spaces. Two forms in the records we have seen. Current numbering: E followed by 10 or 11 digits, a hyphen and 1 digit (e.g. E0082262010-4, E40614102024-7). Older entities: a letter prefix (C, LLC and LP seen so far), up to 5 digits, a hyphen and 4 digits (e.g. C40-1921, C14059-2002, LLC1688-2002, LP38-1987). The register publishes no list of prefixes, so treat the set as open. Primary identifier assigned by the Nevada Secretary of State and shown as the Entity Number on the register. Pass it exactly as a search result returns it: the letters and the hyphenated suffix are part of the number.","example":"LLC1688-2002"},"nvBusinessId":{"type":"string","description":"NV Business ID: NV followed by 11 digits, no separators (e.g. NV20021018811). Cross-agency identifier shared between the Secretary of State and the Nevada Department of Taxation. Not present on all entities.","example":"NV20021018811"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NY","type":"object","properties":{"dosId":{"type":"string","description":"DOS ID: Numeric, 1 to 7 digits, no leading zeros. Most entities have 6 or 7 digits; the oldest have fewer (e.g. 3707). Primary identifier assigned by the New York Department of State Division of Corporations. Visible on every NY DOS Public Inquiry entity detail page and used to look up filings on data.ny.gov.","example":"2494465"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-OH","type":"object","properties":{"ohioId":{"type":"string","description":"Ohio Charter / Entity Number: Observed numeric forms: 4 to 7 digits; none of the sampled numeric IDs had a leading zero (e.g. 1456, 693950, 2420083). Registered trade names and a few older or special registrations carry letters: two letters followed by digits (e.g. RN228652, FN31251, LP3159), or digits followed by one letter (e.g. 14276Z). Primary identifier assigned by the Ohio Secretary of State. Corresponds to the charter_num field on the public business search portal (businesssearch.ohiosos.gov) and the charter number column in the monthly Business Reports. These are observed formats, not an exhaustive register specification. Preserve the returned string, including its letters and any leading zeros; do not pad it to a fixed width.","example":"1067403"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-OK","type":"object","properties":{"filingNumber":{"type":"string","description":"Filing Number: 10 digits, numeric only Primary identifier assigned by the Oklahoma Secretary of State. Displayed on every entity page at sos.ok.gov/corp and used for all register lookups.","example":"3400676484"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-OR","type":"object","properties":{"registryNumber":{"type":"string","description":"Registry Number: Digits, with a hyphen before the last 2 digits for most entities; 3 to 9 digits in total. Most entities: 6 or 7 digits, a hyphen and 2 digits, where the part before the hyphen is zero-padded to 6 digits (e.g. 087399-14, 1496294-95). Some search results carry that part without its leading zero (e.g. 12267-11 for 012267-11). Some entities: 3 to 6 digits with no hyphen (e.g. 414, 443499). The register's open data stores the same numbers as digits only, without the hyphen or leading zeros (e.g. 8739914). Primary identifier assigned by the Oregon Secretary of State Corporation Division and shown as the Registry Number on the Oregon Business Registry. Accepted with or without the hyphen and leading zeros (087399-14, 08739914 and 8739914 resolve to the same entity); responses use the hyphenated form, or the plain digits for numbers under 7 digits.","example":"087399-14"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-PA","type":"object","properties":{"filingNumber":{"type":"string","description":"PA Filing Number: 10 digits, numeric only, with leading zeros preserved (e.g. 0004272272). Primary identifier assigned by the Pennsylvania Department of State. Used to look up entity detail on the Business Filing Services portal and to search the open-data register at data.pa.gov.","example":"0004272272"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-PR","type":"object","properties":{"registrationIndex":{"type":"string","description":"Puerto Rico Department of State register number with suffix: The register number (1 to 6 digits with no leading zeros in the records we have seen), a hyphen, then a suffix. Observed suffixes include a single digit group (e.g. 59124-111, 61-1531, 9-611), several digit groups separated by hyphens or underscores (e.g. 134-12-2-2, 62-1221_1), and, on some migrated records, an empty suffix (e.g. 7620-). Unique per entity. The register number alone can be shared by several unrelated entities, so keep the complete identifier, including all hyphen and underscore suffix segments and a trailing hyphen when the suffix is empty.","example":"59124-111"},"registerNumber":{"type":"string","description":"Puerto Rico Department of State register number (Register No.): 1 to 6 digits with no leading zeros in the records we have seen (e.g. 59124). The number the register displays and prints. It is not unique: a search by this number returns every entity that carries it, each with its own suffixed identifier.","example":"59124"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-RI","type":"object","properties":{"identificationNumber":{"type":"string","description":"RI Identification Number: Nine-digit zero-padded number (e.g. 000015908) Primary identifier assigned by the Rhode Island Department of State Business Services Division to each entity in the Corporate Database.","example":"000015908"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-SC","type":"object","properties":{"guid":{"type":"string","description":"SC SoS Entity GUID: UUID (8-4-4-4-12 hex, lowercase), assigned by the SC Secretary of State Business Entities Online portal and used as the URL key on every entity profile page. Primary identifier assigned by the SC Secretary of State Business Entities Online portal. Visible in every entity profile URL at businessfilings.sc.gov and used for direct entity lookups.","example":"e6980025-c7ec-4715-8bf0-52b5ef0c585f"},"entityId":{"type":"string","description":"SC SoS Entity Id: 8-digit zero-padded integer displayed on the entity profile page. Not accepted as a search input by the public portal. Printed on filed paper documents; returned in `company.identifiers.entityId` so customers can reconcile against their own paperwork. NOT accepted as a lookup input: the SC portal search matches entity names only, so Topograph API calls use the GUID.","example":"00121743"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-SD","type":"object","properties":{"businessId":{"type":"string","description":"Business ID: Exactly 8 characters, no separators: two uppercase letters followed by 6 digits, leading zeros included (e.g. FB033693, DL025748, NS000956). Prefixes seen in our search results: DL, NS, DB, FB, FL, FP, FK, BK, CH, DP, DR, RN, RS, DM, DT, GP and FN; the list is not closed. The register does not publish what the letters mean. Primary identifier assigned by the South Dakota Secretary of State and shown as the Business ID on the register. Pass it exactly as a search result returns it: the two letters and the leading zeros are part of the number.","example":"FB033693"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-TN","type":"object","properties":{"controlNumber":{"type":"string","description":"Control Number: 9-digit zero-padded number assigned by the Tennessee Secretary of State at registration. Accepted as 9 consecutive digits (000239194) or without leading zeros (239194). Primary identifier assigned by the Tennessee Secretary of State. Visible on every entity detail page at tncab.tnsos.gov.","example":"000239194"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-TX","type":"object","properties":{"taxpayerId":{"type":"string","description":"Texas Taxpayer Number: 11 digits, no separators. The first digit is 1 when the number is built on the entity's federal EIN (the next nine digits are the EIN, e.g. 17307175087) and 3 when the Comptroller assigned it (e.g. 32041800429, 30003761332). The last digit is a check digit. Primary identifier assigned by the Texas Comptroller of Public Accounts. Used as the lookup key for both the Franchise Tax and Sales Tax Comptroller systems. Every search result id is a taxpayer number, whichever identifier was searched: use it on /v2/company.","example":"17307175087"},"sosFileNumber":{"type":"string","description":"SOS Filing Number: 10 digits, zero-padded, leading zeros included (e.g. 0803367205, 0003077806). The Secretary of State displays the same number without the leading zeros (803367205, 3077806). In the records we have seen, recent filings start with 080. Filing number assigned by the Texas Secretary of State. Only present for formal entities (corporations, LLCs, limited partnerships and similar); absent for sole traders and sales-tax-only taxpayers. Search accepts it padded or as the Secretary of State displays it (0803367205 or 803367205, 0003077806 or 3077806). The search result id is the taxpayer number.","example":"0003077806"},"feiNumber":{"type":"string","description":"Federal Employer Identification Number: The 9-digit federal EIN as recorded by the Comptroller, without a separator (e.g. 730717508). For a taxpayer number that starts with 1, it is normally the second to tenth digits of that number. Federal Employer Identification Number (FEIN / EIN) as recorded in the Texas Comptroller and Secretary of State systems. Only present when the entity has a FEIN on file; absent for sole traders who registered without one.","example":"730717508"},"stateOfFormation":{"type":"string","description":"State of Formation: Two-letter US state code or \"TX\" for domestic entities (e.g. TX, NJ, DE) US state in which the entity was originally formed, as recorded in the Franchise Tax system. Only present when reported by the Comptroller.","example":"TX"},"sosRegistrationStatus":{"type":"string","description":"SOS Registration Status: Short status string from the Comptroller (e.g. ACTIVE, INACTIVE, NOT REGISTERED) Raw SOS registration status label from the Texas Comptroller Franchise Tax system, returned in prefill mode. Redundant with the top-level company status field but included here for completeness when present.","example":"ACTIVE"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-UT","type":"object","properties":{"entityNumber":{"type":"string","description":"Utah Entity Number: 6 to 8 digits, a hyphen, then 4 digits, with no letters (e.g. 616169-0140, 7228568-0140, 10110445-0143). The four digits after the hyphen follow the entity type: in the records we have seen, -0140 is a domestic nonprofit corporation, -0151 an assumed name (DBA) and -0181 a foreign limited partnership; other values in use include -0141, -0142, -0143, -0150, -0160 and -0161, and the list is not closed. Primary identifier assigned by the Utah Division of Corporations & Commercial Code and shown as the Entity Number on businessregistration.utah.gov. Every id we return carries the hyphen and the four-digit suffix; the digits before the hyphen alone are also accepted as input.","example":"616169-0140"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-VA","type":"object","properties":{"entityId":{"type":"string","description":"SCC ID: 8 characters, no separators, in two forms. One uppercase letter followed by 7 digits (e.g. S0381378, T0479784, F1389198, L0007460, M0093452). Or 8 digits with leading zeros kept (e.g. 02937985, 00003145, 11127380): older corporations carry this form, and so do recent registrations of every entity type, LLCs and limited partnerships included. In the records we have seen, the letter follows the filing family: S (Virginia LLC), T (foreign LLC), F (foreign corporation), L (Virginia limited partnership, and some LLCs), M (foreign limited partnership), J (a few LLCs). The register publishes no meaning for the letters, and the list is not closed. Primary identifier assigned by the Virginia State Corporation Commission, shown as the Entity ID (or SCC ID) in the Clerk's Information System at cis.scc.virginia.gov. Pass it exactly as a search result returns it, letter and leading zeros included.","example":"02937985"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-VT","type":"object","properties":{"entityId":{"type":"string","description":"Record Number: Always 6 digits, zero-padded, leading zeros included (e.g. 074657, 001020, 487831). Primary identifier assigned by the Vermont Secretary of State when the entity is filed. Unique across all filing types (corporations, LLCs, partnerships, assumed names, etc.). Accepted with or without the leading zeros; every id we return carries the 6-digit form.","example":"074657"},"vtIdBusiness":{"type":"string","description":"VT Internal Business ID: UUID, 36 characters with hyphens, lowercase in the records we have seen (e.g. 79304417-fb3e-4bd0-8dda-1a005071a37a) The register's internal key for the entity, returned alongside the Record Number for reference. It cannot be used to search or to request a company: use the Record Number.","example":"79304417-fb3e-4bd0-8dda-1a005071a37a"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WA","type":"object","properties":{"ubi":{"type":"string","description":"UBI (Unified Business Identifier): Always 9 digits, returned without separators (e.g. 600413485, 606026013, 178005030). The register displays it in groups of three (600 413 485); search and company requests also accept the dashed form (600-413-485). The same UBI cross-references the entity across the Secretary of State, Department of Revenue, Labor & Industries, and Employment Security. Primary identifier assigned by the Washington Business Licensing Service.","example":"600413485"},"fein":{"type":"string","description":"FEIN (Federal Employer Identification Number): The 9-digit federal EIN as recorded on the Secretary of State entity profile (e.g. 911144442) Returned when present on the Secretary of State entity profile. Not all entities carry a FEIN.","example":"911144442"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WI","type":"object","properties":{"entityId":{"type":"string","description":"Wisconsin DFI Entity ID: Seven characters: one alpha plus six numerics, accepted in two shapes : modern `A######` (one letter then six digits) or legacy `#A#####` (one digit, one letter, then five digits). Primary identifier assigned by the Wisconsin Department of Financial Institutions. Visible on every WDFI Corporate Records Search entity detail page.","example":"K024598"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WV","type":"object","properties":{"orgNumber":{"type":"string","description":"WV Organization Number: Digits only, with no leading zeros, letters or separators. In the records we have seen it has 4 to 6 digits (e.g. 2011, 20122, 633785). Primary identifier assigned by the West Virginia Secretary of State (the \"Org Id\"). Used to key the entity detail page directly on the Online Data Services portal.","example":"20122"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WY","type":"object","properties":{"filingId":{"type":"string","description":"Filing ID: YYYY-NNNNNNNNN: a 4-digit year prefix, a dash, and a 9-digit zero-padded sequence number issued by the Wyoming Secretary of State upon entity registration. Primary identifier assigned by the Wyoming Secretary of State. Visible on every WyoBiz entity detail page and used as the lookup key on wyobiz.wyo.gov.","example":"2004-000464709"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}}],"example":{"VAT":"02580590541"}}},"required":["matchType"]},"SearchResult":{"type":"object","properties":{"address":{"description":"The legal address of the company","allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"id":{"type":"string","example":"932884117","description":"The company number. In some countries, this might be a concatenation of the registry and city (e.g., in Germany: \"Augsburg HRB 34617\"). The search function will always return a usable company number. Check the documentation to see which number format is used for each country."},"legalName":{"type":"string","description":"Legal name of the company","example":"SEMAPHORE"},"legalNameInEnglish":{"type":"string","example":"Test Display Hong Kong Trading Limited","description":"The English translation or romanization of the legal name, commonly used for international business. Particularly relevant for companies registered with non-Latin alphabet names (e.g., Chinese, Japanese, Korean, etc.)."},"companyNameTransliterations":{"example":["Naftogaz","Naftohaz"],"description":"Deterministic Latin transliterations of the company name, computed using per-country standards (e.g. UA: GOST + KMU 55 + ISO 9). Useful for displaying alternative Latin spellings alongside the original-script `legalName`. Absent or empty for Latin-script companies and for non-Latin countries not yet covered.","type":"array","items":{"type":"string"}},"countryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NB","CA-NL","CA-PE","CA-YT","CA-NT","CA-NU","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","DE-SCHUFA","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KP","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-NJ","US-NM","US-NY","US-OH","US-TX","US-DE","US-WA","US-AL","US-TN","US-WY","US-GA","US-MN","US-MO","US-NV","US-PA","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","US-NH","US-PR","TEST"],"example":"FR","description":"The country code in ISO 3166-1 alpha-2 format (e.g., \"FR\" for France, \"DE\" for Germany)."},"matchReason":{"description":"Match reason containing information about why this result was returned. Includes the match type and which identifier matched for ID matches.","example":{"matchType":"default"},"allOf":[{"$ref":"#/components/schemas/MatchReason"}]}},"required":["address","id","legalName","countryCode","matchReason"]},"GlobalSearchQuery":{"type":"object","properties":{"name":{"type":"string","description":"The company name read out of your query.","example":"Bamberger GmbH"},"latinName":{"type":"string","description":"Latin spelling, when the name is written in another script."},"legalForm":{"type":"string","description":"The legal form found in the name.","example":"GmbH"},"address":{"type":"string","description":"The address read out of your query.","example":"Wien"},"identifier":{"type":"string","description":"A registration, VAT or LEI number read out of your query.","example":"FN 370916s"},"website":{"type":"string","description":"A website read out of your query.","example":"altria.com"},"mentionedCountries":{"description":"Countries your query names as where the company is (\"Metinvest B.V., Netherlands\"). A belief the search weighs, not a filter.","example":["NL"],"type":"array","items":{"type":"string"}},"sourceCountry":{"type":"string","description":"The country of the filing the name came from (\"from a UK filing\"). A weak signal: a holder's stated domicile is often not where it is incorporated.","example":"GB"}},"required":["name"]},"GlobalSearchMatchReasonKind":{"type":"string","enum":["legal_form","address","country_hint","source_filing","website","identifier","company_data","public_source","register_match","address_match","distance","other_registration"],"description":"What kind of reason this is."},"GlobalSearchMatchReason":{"type":"object","properties":{"kind":{"description":"What kind of reason this is.","allOf":[{"$ref":"#/components/schemas/GlobalSearchMatchReasonKind"}]},"text":{"type":"string","description":"The reason as a sentence you can show a user.","example":"The register in Austria lists it under exactly that name"},"countryCode":{"type":"string","description":"The country the reason is about.","example":"AT"},"url":{"type":"string","description":"`public_source` only: the page that states it.","example":"https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&CIK=0000764180"}},"required":["kind","text"]},"GlobalSearchExplanation":{"type":"object","properties":{"summary":{"type":"string","description":"Why this candidate matched, in one or two sentences."},"reasons":{"description":"The reasons, one per line.","type":"array","items":{"$ref":"#/components/schemas/GlobalSearchMatchReason"}}},"required":["summary","reasons"]},"GlobalSearchMatchStrength":{"type":"string","enum":["strong","possible"],"description":"`strong`: this is the company, as far as the evidence goes. `possible`: a plausible candidate that needs a second look. Several candidates can be `strong` (the same name in two countries) while none is `selected`."},"GlobalSearchCandidate":{"type":"object","properties":{"selected":{"type":"boolean","description":"`true` on the company itself, when the search can stand behind one candidate: a strong match with no plausible rival. At most one candidate is selected, always the first, and only when `status` is `resolved`. Use it without a person checking; when no candidate is selected, show the candidates to a person."},"match":{"description":"`strong`: this is the company, as far as the evidence goes. `possible`: a plausible candidate that needs a second look. Several candidates can be `strong` (the same name in two countries) while none is `selected`.","allOf":[{"$ref":"#/components/schemas/GlobalSearchMatchStrength"}]},"countryCode":{"type":"string","description":"Topograph country code; US states as `US-DE`. Use it with `/v2/company`.","example":"AT"},"id":{"type":"string","description":"Registration number in that register, as `/v2/company` expects it.","example":"370916s"},"legalName":{"type":"string","example":"Bamberger GmbH"},"legalNameInEnglish":{"type":"string"},"companyNameTransliterations":{"type":"array","items":{"type":"string"}},"address":{"$ref":"#/components/schemas/AddressDTO"},"isActive":{"type":"boolean","description":"Indicative only: whether the company looked active when it was searched, absent when unknown. It comes from a register's search results or from Topograph's company data, which can lag the register, so it may be out of date. For the current status, request `company` from `/v2/company` and read `company.status`."},"explanation":{"$ref":"#/components/schemas/GlobalSearchExplanation"}},"required":["selected","match","countryCode","id","legalName","explanation"]},"GlobalSearchUsage":{"type":"object","properties":{"priceCents":{"type":"number","description":"What this search was charged, in credit cents. 0 unless `status` is `resolved`."},"durationMs":{"type":"number"}},"required":["priceCents","durationMs"]},"GlobalSearchStatus":{"type":"string","enum":["resolved","ambiguous","not_found"],"description":"`resolved`: one strong match, the `selected` candidate. `ambiguous`: several plausible candidates (including namesakes in one register the evidence cannot tell apart), or one weak one. `not_found`: nothing acceptable; see `reason`."},"GlobalSearchReason":{"type":"string","enum":["not_a_legal_entity","no_country_signal","country_not_covered","no_register_match","search_limit_reached","timeout","outside_countries"],"description":"Why the search ended `not_found`, or why it stopped early."},"GlobalSearchResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifies this search. Quote it when you contact support about it.","example":"global-search-1791216000000-k3x9qa"},"status":{"description":"`resolved`: one strong match, the `selected` candidate. `ambiguous`: several plausible candidates (including namesakes in one register the evidence cannot tell apart), or one weak one. `not_found`: nothing acceptable; see `reason`.","allOf":[{"$ref":"#/components/schemas/GlobalSearchStatus"}]},"reason":{"description":"Why the search ended `not_found`, or why it stopped early.","allOf":[{"$ref":"#/components/schemas/GlobalSearchReason"}]},"summary":{"type":"string","description":"The outcome in one sentence.","example":"Found in Austria: Bamberger GmbH (370916s)."},"likelyCountryCode":{"type":"string","description":"The country the evidence points to, even when the company could not be confirmed, Topograph does not cover its register, or it is outside `countries`.","example":"KY"},"query":{"description":"What was understood from your input.","allOf":[{"$ref":"#/components/schemas/GlobalSearchQuery"}]},"candidates":{"description":"Candidates, best first. Empty on `not_found`. On `resolved`, the first one is `selected`.","type":"array","items":{"$ref":"#/components/schemas/GlobalSearchCandidate"}},"usage":{"$ref":"#/components/schemas/GlobalSearchUsage"}},"required":["id","status","summary","query","candidates","usage"]},"GlobalSearchProgress":{"type":"object","properties":{"isComplete":{"type":"boolean"},"revision":{"type":"number","description":"Bumped on every change; a new `progress` event is sent each time it moves."},"activity":{"description":"What the search is doing right now, as sentences to show a user (\"Asking the register in Austria\"). For display only: the wording changes as the search improves.","example":["Asking the register in Austria"],"type":"array","items":{"type":"string"}},"query":{"$ref":"#/components/schemas/GlobalSearchQuery"},"candidates":{"description":"Candidates found so far, best first. None is `selected` before the `complete` event.","type":"array","items":{"$ref":"#/components/schemas/GlobalSearchCandidate"}}},"required":["isComplete","revision","activity","candidates"]},"GlobalSearchRequestDto":{"type":"object","properties":{"query":{"type":"string","description":"What you know about the company, in one string: the name first, then anything else, separated by commas (\"Bamberger GmbH, Wien\", \"MFG Investments EOOD, from a UK filing\", \"Altria Group Inc., Richmond VA, altria.com\", or an LEI alone). The name, the address, an identifier, a website and the countries it names are read out of it for you, and returned in `query`.","example":"Bamberger GmbH, Wien"},"countries":{"description":"Search only these countries: Topograph country codes, `US-DE` for one US state, `US` for every US state, `CA-FED` for the Canadian federal register, `CA-ON` for one Canadian province or territory, `CA` for every Canadian jurisdiction. Nothing outside them is searched or returned. Unlike a country named in `query`, which only says where you think the company is, this is a filter. Omit it to search every country.","example":["US"],"type":"array","items":{"type":"string"}},"activeOnly":{"type":"boolean","description":"Leave out companies the search sees as inactive. It filters on the same indicative status as `isActive`: a company whose status is unknown is kept, so a candidate is not proof that the company is active.","example":false},"strictActiveOnly":{"type":"boolean","description":"Return only candidates explicitly reported as active, excluding unknown statuses. Implies activeOnly. Status remains indicative and may come from a periodic snapshot.","example":false},"stream":{"type":"boolean","description":"Streaming mode: Server-Sent Events with `progress` events (the steps so far, and the candidates found so far), one `complete` event carrying the final response, or an `error` event. Set Accept to `text/event-stream`.","example":false}},"required":["query"]},"VaultEntryView":{"type":"object","properties":{"sourceKey":{"type":"string","example":"de_transparenzregister"},"origin":{"type":"string","example":"customer_provided"},"shape":{"type":"string","example":"email_password"},"ownerWorkspaceId":{"type":"string","description":"Workspace the row physically lives on."},"inheritedFromWorkspaceId":{"type":"string","description":"Workspace this entry was resolved from when serving the requested workspace. Equal to ownerWorkspaceId for direct hits, equal to the default workspace for inherited reads."},"version":{"type":"number","example":1,"description":"Generation counter, bumped on PUT. Last-write-wins under concurrent PUTs — two PUTs racing on the same (workspace, sourceKey) may both observe version N and both write N+1; one payload survives. Not a strict monotonic per-PUT counter."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time","nullable":true}},"required":["sourceKey","origin","shape","ownerWorkspaceId","version","createdAt","updatedAt","expiresAt"]},"PutVaultEntryDto":{"type":"object","properties":{"payload":{"type":"object","description":"Credential payload. Shape depends on the sourceKey format. Call `GET /v2/vault/sources` to learn the required fields.","additionalProperties":true,"example":{"email":"compliance@example.com","password":"••••••••"}}},"required":["payload"]},"DiscrepancyReportOwnerNameDto":{"type":"object","properties":{"fullName":{"type":"string","description":"Full name of the person, as it should appear in the register","example":"Erika Mustermann"},"title":{"type":"string","description":"Title of the person (e.g. Dr.)"},"firstName":{"type":"string","description":"First name of the person","example":"Erika"},"middleName":{"type":"string","description":"Middle name of the person"},"lastName":{"type":"string","description":"Last name of the person","example":"Mustermann"},"suffix":{"type":"string","description":"Suffix of the name (e.g. Jr.)"}},"required":["fullName"]},"DiscrepancyReportOwnerBirthDateDto":{"type":"object","properties":{"day":{"type":"number","description":"Day of birth (1-31)","example":15},"month":{"type":"number","description":"Month of birth (1-12), where January is 1","example":7},"year":{"type":"number","description":"Year of birth","example":1980}}},"DiscrepancyReportOwnerAddressDto":{"type":"object","properties":{"city":{"type":"string","description":"City of residence","example":"Berlin"},"countryCode":{"type":"string","description":"Country of residence (ISO 3166-1 alpha-2)","example":"DE"}}},"DiscrepancyReportPercentageRangeDto":{"type":"object","properties":{"lower":{"type":"number","description":"Lower bound of the range","example":25},"upper":{"type":"number","description":"Upper bound of the range","example":50}},"required":["lower","upper"]},"DiscrepancyReportPercentageDetailDto":{"type":"object","properties":{"type":{"type":"string","description":"What the percentage measures","enum":["shares","voting-rights"],"example":"shares"},"percentageValue":{"type":"number","description":"Exact percentage","example":100},"percentageRange":{"description":"Range, when only bounds are known. Ignored when `percentageValue` is set.","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportPercentageRangeDto"}]},"nature":{"type":"string","description":"Whether the control is direct or indirect. Omit or send `null` when unknown.","enum":["direct","indirect",null],"nullable":true}},"required":["type"]},"DiscrepancyReportControlDto":{"type":"object","properties":{"types":{"type":"array","description":"Types of control held by the beneficial owner","items":{"type":"string","enum":["ownership-of-shares","voting-rights","appoint-and-remove-directors","significant-influence-or-control"]},"example":["ownership-of-shares"]},"details":{"description":"Percentages of control. Never invented: send only what you established.","type":"array","items":{"$ref":"#/components/schemas/DiscrepancyReportPercentageDetailDto"}}},"required":["types"]},"DiscrepancyReportOwnerDto":{"type":"object","properties":{"gender":{"type":"string","description":"Gender of the person. In German it decides the grammatical form of the filed text.","enum":["Male","Female","Other","PreferNotToSay"],"example":"Male"},"name":{"description":"Name of the person","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportOwnerNameDto"}]},"birthDate":{"description":"Birth date; partial dates (year only, year and month) are accepted","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportOwnerBirthDateDto"}]},"nationality":{"type":"string","description":"Nationality (ISO 3166-1 alpha-2)","example":"DE"},"residenceAddress":{"description":"Residence of the person","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportOwnerAddressDto"}]},"control":{"description":"How the person owns or controls the company","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportControlDto"}]}},"required":["name"]},"DiscrepancyReportEvidenceType":{"type":"string","enum":["public_register_reference"],"description":"What the report relies on. `public_register_reference`: the discrepancy can be established from public registers (in Germany, § 22 GwG). Other evidence types, such as uploaded documents, will be added."},"DiscrepancyReportEvidenceDto":{"type":"object","properties":{"type":{"description":"What the report relies on. `public_register_reference`: the discrepancy can be established from public registers (in Germany, § 22 GwG). Other evidence types, such as uploaded documents, will be added.","example":"public_register_reference","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportEvidenceType"}]}},"required":["type"]},"DiscrepancyReportStatus":{"type":"string","enum":["in_progress","succeeded","failed"],"description":"`in_progress`: accepted and being filed. `succeeded`: filed with the register; `filing.registerReference` and `filing.receipt` are set. `failed`: nothing was filed; see `error`, then correct and resend with a new `Idempotency-Key`."},"DiscrepancyReportRegisterDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the register the report is filed with","example":"Transparenzregister"}},"required":["name"]},"DiscrepancyReportReceiptDto":{"type":"object","properties":{"url":{"type":"string","description":"Signed download link to the register receipt (PDF). It expires after 15 minutes; fetch the report again for a fresh link. Topograph keeps the receipt, so it stays available after the register stops serving it.","example":"https://storage.topograph.co/documents/discrepancy-reports/receipt.pdf?sv=..."},"expiresAt":{"type":"string","description":"When `url` expires (ISO 8601)","example":"2026-10-27T14:27:47.000Z"},"sha256":{"type":"string","description":"SHA-256 of the receipt, to prove later that a stored copy is the one received","example":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"}},"required":["url","expiresAt","sha256"]},"DiscrepancyReportFilingDto":{"type":"object","properties":{"language":{"type":"string","description":"Language of the filed explanation (ISO 639-1), the register's language","example":"de"},"text":{"type":"string","description":"The exact explanation filed with the register, generated from `ultimateBeneficialOwners` and `comment`. Available from the moment the report is accepted.","example":"Die wirtschaftlich Berechtigte ist Erika Mustermann mit 100 %."},"registerReference":{"type":"string","description":"The register's own reference for the report. Present once the report is filed.","example":"261000000001"},"submittedAt":{"type":"string","description":"When the register received the report (ISO 8601). Present once the report is filed.","example":"2026-10-27T14:11:47.000Z"},"receipt":{"description":"The register's acknowledgement of receipt. Present once the report is filed and the receipt collected.","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportReceiptDto"}]}},"required":["language","text"]},"DiscrepancyReportErrorDto":{"type":"object","properties":{"code":{"type":"string","description":"Public error code","example":"resource_not_found"},"message":{"type":"string","description":"Human-readable explanation","example":"Resource not found"}},"required":["code","message"]},"DiscrepancyReportDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the report","example":"0b7e8a3c-5d2f-4c1e-9a6b-7f8e9d0c1b2a"},"status":{"description":"`in_progress`: accepted and being filed. `succeeded`: filed with the register; `filing.registerReference` and `filing.receipt` are set. `failed`: nothing was filed; see `error`, then correct and resend with a new `Idempotency-Key`.","example":"succeeded","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportStatus"}]},"countryCode":{"type":"string","description":"Country of the company","example":"DE"},"companyId":{"type":"string","description":"The company ID","example":"München HRB 228960"},"register":{"description":"The register the report is filed with","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportRegisterDto"}]},"reasons":{"type":"array","description":"Why the register is wrong, as sent","items":{"type":"string","enum":["incorrect_or_incomplete_information","different_beneficial_owners"]},"example":["incorrect_or_incomplete_information"]},"ultimateBeneficialOwners":{"description":"The beneficial owners, as sent","type":"array","items":{"$ref":"#/components/schemas/DiscrepancyReportOwnerDto"}},"evidence":{"description":"Evidence the report relies on, as sent","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportEvidenceDto"}]},"comment":{"type":"string","description":"Free text appended to the explanation, as sent"},"filing":{"description":"What was filed, and the register acknowledgement","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportFilingDto"}]},"error":{"description":"Why the report failed. Present only when `status` is `failed`.","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportErrorDto"}]},"sourceRequestId":{"type":"string","description":"The company request the report refers to, as sent"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"example":{"caseId":"case-12345"},"description":"Key-value pairs provided at creation"},"createdAt":{"type":"string","description":"Creation time (ISO 8601)","example":"2026-10-27T14:10:02.000Z"},"updatedAt":{"type":"string","description":"Last update time (ISO 8601)","example":"2026-10-27T14:12:46.000Z"}},"required":["id","status","countryCode","companyId","register","reasons","ultimateBeneficialOwners","evidence","filing","createdAt","updatedAt"]},"ListDiscrepancyReportsResponseDto":{"type":"object","properties":{"discrepancyReports":{"description":"Reports, newest first","type":"array","items":{"$ref":"#/components/schemas/DiscrepancyReportDto"}},"total":{"type":"number","description":"Total number of reports matching the filters","example":3},"hasNextPage":{"type":"boolean","description":"Whether there is a next page available","example":false},"nextCursor":{"type":"string","description":"Cursor for the next page"}},"required":["discrepancyReports","total","hasNextPage"]},"DiscrepancyReportUsageDto":{"type":"object","properties":{"limit":{"type":"number","description":"Reports allowed in the current period by your subscription. Absent when no allowance applies.","example":50},"used":{"type":"number","description":"Reports counted in the current period. Failed reports are not counted: nothing was filed.","example":12},"remaining":{"type":"number","description":"Reports left in the current period. Absent when no allowance applies.","example":38},"periodStart":{"type":"string","description":"Start of the current period (ISO 8601). Absent when no allowance applies."},"periodEnd":{"type":"string","description":"End of the current period (ISO 8601, exclusive); the allowance renews then. Absent when no allowance applies."}},"required":["used"]},"DiscrepancyReportAttestationDto":{"type":"object","properties":{"accepted":{"type":"boolean","description":"Must be `true`. By sending it you confirm, as the register requires of every reporter, that you compared the register entry with the information you hold, that you determined the beneficial owners as the law requires, and that you are entitled to report. The report is filed as soon as it is accepted.","example":true}},"required":["accepted"]},"CreateDiscrepancyReportDto":{"type":"object","properties":{"countryCode":{"type":"string","description":"Country of the company. Supported during the beta: Germany (`DE`); more countries are coming.","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"],"example":"DE"},"companyId":{"type":"string","description":"The company ID, as used by `POST /v2/company`","example":"München HRB 228960"},"reasons":{"type":"array","description":"Why the register is wrong. `incorrect_or_incomplete_information`: details of a registered beneficial owner are wrong or incomplete. `different_beneficial_owners`: you identified different beneficial owners. More values may be added; tolerate unknown ones.","items":{"type":"string","enum":["incorrect_or_incomplete_information","different_beneficial_owners"]},"example":["incorrect_or_incomplete_information"]},"ultimateBeneficialOwners":{"description":"The beneficial owners as you believe the register should list them, in the same shape as `ultimateBeneficialOwners` in the company response. The filed explanation is written from these facts only.","type":"array","items":{"$ref":"#/components/schemas/DiscrepancyReportOwnerDto"}},"evidence":{"description":"Evidence the report relies on","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportEvidenceDto"}]},"comment":{"type":"string","description":"Free text appended to the generated explanation, in the register's language (German for Germany). The whole explanation must fit the register's limit (1,000 characters in Germany).","example":"Die Beteiligung wurde im Rahmen unserer Sorgfaltspflichten festgestellt."},"attestation":{"description":"Your attestation; the report is filed on acceptance","allOf":[{"$ref":"#/components/schemas/DiscrepancyReportAttestationDto"}]},"sourceRequestId":{"type":"string","description":"The `requestId` of the company request that showed the register data you are disputing, if any","example":"4f1c3a0e-8b9d-4d6e-a1f2-3c4d5e6f7a8b"},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"example":{"caseId":"case-12345"},"description":"Arbitrary key-value string pairs echoed back in responses and in every discrepancy_report.updated webhook. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated)."}},"required":["countryCode","companyId","reasons","ultimateBeneficialOwners","evidence","attestation"]},"CreateCompanyRequestDTO":{"type":"object","properties":{"id":{"type":"string","example":"932884117","description":"The company id. In some countries, this might be a concatenation of the registry and city (e.g., in Germany: \"Augsburg HRB 34617\"). The search function will always return a usable company number. Check the documentation to see which number format is used for each country. Optional when `graphContinueFromNodeIds` is set — the server derives it from the parent request."},"countryCode":{"type":"string","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"],"example":"FR","description":"The country code in ISO 3166-1 alpha-2 format (e.g., \"FR\" for France, \"DE\" for Germany). Optional when `graphContinueFromNodeIds` is set — the server derives it from the parent request."},"dataPoints":{"type":"array","items":{"type":"string","enum":["companyProfile","ultimateBeneficialOwners","availableDocuments","shareholders","graph","company","legalRepresentatives","otherKeyPersons","establishments","subsidiaries"]},"example":["company","legalRepresentatives"],"description":"The data points to retrieve: company, legalRepresentatives, otherKeyPersons, establishments, shareholders, subsidiaries, ultimateBeneficialOwners, availableDocuments, graph. Legacy companyProfile is deprecated and accepted only before December 1, 2026 at 00:00 UTC; new requests containing it return HTTP 400 from that instant. Replace it with the explicit company-level datapoints you need."},"documents":{"type":"array","items":{"type":"string"},"example":["1c932de4-4610-5506-b48d-4e62529d58e8"],"description":"List of document IDs to retrieve. Discover these IDs by requesting the \"availableDocuments\" data point first, then pass the returned IDs here in a follow-up request."},"graphContinueFromNodeIds":{"type":"array","items":{"type":"string"},"example":["FR:12345","DE:HRB999"],"description":"Continue a previous graph request from specific leaf nodes. Each nodeId must refer to a `budget_truncated` node in the parent request's graph (discover them in the parent's response). When set, the new request is linked to the parent via `mainRequestId`, `countryCode` and `id` are derived from the parent, and BFS seeds from these leaves instead of the root company. Cost deduplication applies across the full request tree, so already-paid companies are not re-billed. If the parent request ran with `graphInteractive: true`, every continuation inherits that flag automatically (any client-supplied value is ignored) so chip-driven exploration stays one level at a time."},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Arbitrary key-value string pairs to associate with the request. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated)."},"graphMaxBudget":{"type":"number","example":1000,"description":"Maximum budget in credit cents for graph traversal. When the \"graph\" datapoint is requested, the traversal will stop once this budget is reached. If not provided, uses a default maximum. Ignored when `graphInteractive` is true."},"graphInteractive":{"type":"boolean","example":false,"description":"Interactive graph mode. When true, the traversal fetches only the entry node (the root for an initial request, the seeded node for a continuation) and stops; its direct shareholders are returned as graph nodes — companies among them appear as `budget_truncated` chips that you can pass back into a follow-up request via `graphContinueFromNodeIds`. Every continuation under a parent that ran with `graphInteractive: true` is auto-flagged interactive (server-enforced) so chip-driven exploration stays one level at a time. Use this for deliberate, click-by-click exploration with predictable per-step cost. Ignores `graphMaxBudget`."},"profileMaxBudget":{"type":"number","example":500,"description":"Maximum budget in credit cents for company profile retrieval. For countries with variable pricing (e.g., Hungary), the request will fail with a budget_exceeded error if the actual cost exceeds this budget. The error includes the quoted price so the user can retry with a higher budget."},"mode":{"type":"string","enum":["verification","prefill"],"description":"Data retrieval mode. \"verification\" (default) selects authoritative live registry sources, and marks datapoints as failed with error code \"authoritative_source_unavailable\" when a country is served only by a non-authoritative source (some countries are prefill-only). \"prefill\" selects the cheapest compatible fast source for form prefill and initial screening, and marks unsupported datapoints as failed with error code \"fast_source_unavailable\" when no fast source exists. The \"graph\" datapoint has no fast source and is always rejected with \"fast_source_unavailable\" in prefill mode; request it in verification mode."},"fast":{"type":"boolean","deprecated":true,"description":"Deprecated. Use mode: \"prefill\" instead."},"authoritative":{"type":"boolean","deprecated":true,"description":"Deprecated. Use mode instead."},"maxBudget":{"type":"number","example":200,"description":"Hard cap on total block cost in credit cents. If the resolved blocks exceed this budget, the request fails with a budget_exceeded error including the actual cost and suggestion."},"maxRetryDelaySeconds":{"type":"number","minimum":60,"maximum":172800,"description":"Retry eligible failed items in verification mode until this start-by window ends, in seconds."},"agenticEnrichment":{"type":"boolean","example":true,"description":"Enable best-effort enrichment of legal representative person details (birth date, nationality, residence address) and signing powers (`signingPowers`, `signingAuthority`, and `representationMode` when one mode applies) from official publications. Belgium only. Not all fields are guaranteed — depends on publication availability. Fixed 50 cent cost per request, charged only if enrichment yields results. Introduces `enriching` datapoint status while processing is in progress."}}},"GetCompanyRequestResultDTO":{"type":"object","properties":{"requestId":{"type":"string","example":"123e4567-e89b-12d3-a456-426614174000","description":"Optional UUID that references a previous request. When provided, returns cached data from that specific request instead of fetching fresh data."}},"required":["requestId"]},"SecurityMarketDTO":{"type":"object","properties":{"mic":{"type":"string","example":"XPAR","description":"ISO 10383 MIC of the reported venue or segment."},"operatingMic":{"type":"string","example":"XPAR","description":"Operating MIC associated with the venue or segment."},"name":{"type":"string","example":"EURONEXT - EURONEXT PARIS"},"countryCode":{"type":"string","example":"FR","description":"ISO 3166 country code of the market, independently of the issuer."},"categoryCode":{"type":"string","example":"RMKT","description":"ISO 10383 market category; does not establish AML eligibility."}},"required":["mic","operatingMic","name","countryCode","categoryCode"]},"ListingEvidenceDTO":{"type":"object","properties":{"basis":{"type":"string","enum":["issuerApprovedAdmissionOrTrading"],"description":"The source reports issuer-requested or approved admission or trading. Formal market admission requires separate confirmation."},"publishedAt":{"type":"string","format":"date-time","description":"Publication timestamp of the source record."},"observedAt":{"type":"string","format":"date-time","description":"When the source record was retrieved. Preserved when the response is reused."},"firstAdmissionOrTradeAt":{"type":"string","format":"date-time","description":"First admission, trade or quote timestamp reported by the source."},"reportedTerminationAt":{"type":"string","format":"date-time","description":"Future termination timestamp, when reported by the source."}},"required":["basis","publishedAt","observedAt","firstAdmissionOrTradeAt"]},"SecurityListingDTO":{"type":"object","properties":{"market":{"$ref":"#/components/schemas/SecurityMarketDTO"},"evidence":{"$ref":"#/components/schemas/ListingEvidenceDTO"}},"required":["market","evidence"]},"ListedSecurityDTO":{"type":"object","properties":{"isin":{"type":"string","example":"FR0000121014","description":"ISIN of the security issued by this legal entity."},"instrumentType":{"type":"string","enum":["equity","fundUnit"]},"listings":{"description":"Distinct markets reported for this security within the source coverage.","type":"array","items":{"$ref":"#/components/schemas/SecurityListingDTO"}}},"required":["isin","instrumentType","listings"]},"TaxIdVerificationDTO":{"type":"object","properties":{"status":{"type":"string","enum":["verified","unverified","unavailable"],"description":"Verification status of the tax ID","example":"verified"},"verifiedAt":{"type":"string","description":"ISO date when the tax ID was verified","example":"2024-01-15T10:30:00Z"},"verifiedName":{"type":"string","description":"Company name returned by the validation service (e.g., VIES)","example":"TOPOGRAPH SAS"},"verifiedAddress":{"type":"string","description":"Address returned by the validation service (e.g., VIES)","example":"123 RUE DE PARIS, 75001 PARIS"},"consultationNumber":{"type":"string","description":"VIES consultation number (requestIdentifier) - the legal proof of validation for audit purposes","example":"WAPIAAAAW1234567890"},"source":{"type":"string","enum":["vies","agenzia_entrate","arca","abr"],"description":"Authority that produced the verification: `vies` (intra-EU registration, carries a consultation number), `agenzia_entrate` (Italian domestic VAT status from the Agenzia delle Entrate), `arca` (the Argentine CUIT registration record held by ARCA) or `abr` (Australian Business Register: the ABN is active and registered for GST).","example":"vies"}},"required":["status"]},"TaxIdDTO":{"type":"object","properties":{"type":{"type":"string","description":"Tax ID type (Stripe-aligned)","example":"eu_vat"},"value":{"type":"string","description":"Tax ID value WITHOUT country prefix","example":"64443061841"},"country":{"type":"string","description":"ISO2 country code","example":"FR"},"verification":{"description":"Verification details for the tax ID","allOf":[{"$ref":"#/components/schemas/TaxIdVerificationDTO"}]}},"required":["type","value","country"]},"CompanyStatusDetailsDTO":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","UNDER_INSOLVENCY_PROCEEDING","INACTIVE_NOT_CLOSED","PENDING_DISSOLUTION","CLOSED","UNKNOWN"],"example":"ACTIVE","description":"The standardized status of the company"},"closureReason":{"type":"string","enum":["BANKRUPTCY","LIQUIDATION","MERGER","ACQUISITION","VOLUNTARY_DISSOLUTION","ADMINISTRATIVE_DISSOLUTION","COURT_ORDER","SPLIT","OTHER","UNKNOWN"],"example":"BANKRUPTCY","description":"The reason for company closure, if applicable"},"closureDate":{"type":"string","example":"2024-01-15","description":"The date when the company was closed, if applicable"},"insolvencyStartDate":{"type":"string","example":"2023-12-01","description":"The date when insolvency proceedings started, if applicable"},"additionalInfo":{"type":"string","example":"Company entered voluntary liquidation due to retirement of owner","description":"Additional information about the status"}},"required":["status"]},"CompanyStatusDTO":{"type":"object","properties":{"localName":{"type":"string","example":"active","description":"The local status of the company in the local language"},"active":{"type":"boolean","example":true,"description":"Indicates if the company is active."},"statusDetails":{"description":"Detailed status information including closure reasons and dates","allOf":[{"$ref":"#/components/schemas/CompanyStatusDetailsDTO"}]}},"required":["localName"]},"UboConfirmationOverdueFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","description":"The UBO register’s explicit answer about whether annual declaration confirmation is overdue."},"dueDate":{"type":"string","format":"date","description":"Deadline missed for annual UBO declaration confirmation, when reported by the source."},"since":{"type":"string","format":"date","description":"Date the confirmation became overdue, when reported by the source."},"source":{"type":"string","description":"The UBO register reporting the statement.","example":"ubo_register"},"lastConfirmedOn":{"type":"string","format":"date","description":"Last annual confirmation date reported by the UBO register. A confirmation can occur without an ownership change."},"lastUpdatedOn":{"type":"string","format":"date","description":"Last declaration modification date reported by the register; independent of annual confirmation."},"observedAt":{"type":"string","format":"date-time","description":"Time this statement was observed at the source. ISO 8601 UTC."}},"required":["active"]},"UboAdministrativeStrikingOffFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the register explicitly reports an administrative striking-off notice for non-compliance with UBO obligations."},"since":{"type":"string","format":"date","description":"Effective date of the notice, when published by the register."},"source":{"type":"string","description":"The register reporting the notice.","example":"bce"},"observedAt":{"type":"string","format":"date-time","description":"Time this notice was observed at the source. ISO 8601 UTC."}},"required":["active"]},"AccountsOverdueFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"Whether the signal is currently active (the accounts are currently overdue)."},"dueDate":{"type":"string","example":"2024-09-30","description":"The date the accounts were due (and missed), when the register reports it. ISO 8601 (YYYY-MM-DD)."},"since":{"type":"string","example":"2024-10-01","description":"The date the flag became active, when the register reports it. ISO 8601 (YYYY-MM-DD)."},"source":{"type":"string","example":"companies_house","description":"The register that reported the signal."}},"required":["active"]},"AnnualFilingOverdueFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"Whether the signal is currently active (the annual filing is currently overdue)."},"dueDate":{"type":"string","example":"2024-03-01","description":"The date the filing was due (and missed), when the register reports it. ISO 8601 (YYYY-MM-DD)."},"since":{"type":"string","example":"2024-03-15","description":"The date the flag became active, when the register reports it. ISO 8601 (YYYY-MM-DD)."},"source":{"type":"string","example":"companies_house","description":"The register that reported the signal."}},"required":["active"]},"RegisteredChargesFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"The register’s own answer: `true` when it records charges, mortgages or pledges over the company’s assets, `false` when it states there are none."},"since":{"type":"string","example":"2019-11-04","description":"The date the earliest outstanding charge was registered, when the register reports it. ISO 8601 (YYYY-MM-DD)."},"source":{"type":"string","example":"companies_house","description":"The register that reported the signal."}},"required":["active"]},"InsolvencyHistoryFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"The register’s own answer: `true` when it records insolvency proceedings in the company’s history, `false` when it states there are none."},"since":{"type":"string","example":"2016-02-18","description":"The date the earliest recorded proceeding opened, when the register reports it. ISO 8601 (YYYY-MM-DD)."},"source":{"type":"string","example":"companies_house","description":"The register that reported the signal."}},"required":["active"]},"LiquidatedFlagDTO":{"type":"object","properties":{"active":{"type":"boolean","example":true,"description":"The register’s own answer: `true` when it records that the company has been liquidated, `false` when it states it has not."},"since":{"type":"string","example":"2018-07-30","description":"The date liquidation commenced, when the register reports it. ISO 8601 (YYYY-MM-DD)."},"source":{"type":"string","example":"companies_house","description":"The register that reported the signal."}},"required":["active"]},"ComplianceFlagsDTO":{"type":"object","properties":{"uboConfirmationOverdue":{"description":"Annual UBO confirmation overdue, only when the UBO register explicitly reports it. Absence means unknown.","allOf":[{"$ref":"#/components/schemas/UboConfirmationOverdueFlagDTO"}]},"uboAdministrativeStrikingOff":{"description":"Administrative striking-off for UBO non-compliance, separately from company legal status. Absence means unknown.","allOf":[{"$ref":"#/components/schemas/UboAdministrativeStrikingOffFlagDTO"}]},"accountsOverdue":{"description":"The standing of the company’s statutory annual accounts, when the register reports it.","allOf":[{"$ref":"#/components/schemas/AccountsOverdueFlagDTO"}]},"annualFilingOverdue":{"description":"The standing of the company’s periodic confirmation/annual filing, when the register reports it (in the UK, the Companies House confirmation statement).","allOf":[{"$ref":"#/components/schemas/AnnualFilingOverdueFlagDTO"}]},"registeredCharges":{"description":"Whether the register records charges, mortgages or pledges over the company’s assets.","allOf":[{"$ref":"#/components/schemas/RegisteredChargesFlagDTO"}]},"insolvencyHistory":{"description":"Whether the register records insolvency proceedings in the company’s history.","allOf":[{"$ref":"#/components/schemas/InsolvencyHistoryFlagDTO"}]},"liquidated":{"description":"Whether the register records that the company has been through liquidation.","allOf":[{"$ref":"#/components/schemas/LiquidatedFlagDTO"}]}}},"LastFilingDTO":{"type":"object","properties":{"year":{"type":"integer","example":2025,"description":"The filing year, for registers that publish only a year rather than a date (several US states)."},"periodStart":{"type":"string","example":"2024-04-01","description":"First day of the period this filing covered. ISO 8601 (YYYY-MM-DD)."},"periodEnd":{"type":"string","example":"2025-03-31","description":"Last day of the period this filing covered — the \"made up to\" date. ISO 8601 (YYYY-MM-DD)."},"dueDate":{"type":"string","example":"2025-12-31","description":"The date this filing was due. ISO 8601 (YYYY-MM-DD)."},"filedOn":{"type":"string","example":"2025-06-12","description":"The date the register actually received the filing. ISO 8601 (YYYY-MM-DD)."}}},"NextFilingDTO":{"type":"object","properties":{"year":{"type":"integer","example":2026,"description":"The filing year, for registers that publish only a year rather than a date (several US states)."},"periodStart":{"type":"string","example":"2025-04-01","description":"First day of the period this filing will cover. ISO 8601 (YYYY-MM-DD)."},"periodEnd":{"type":"string","example":"2026-03-31","description":"Last day of the period this filing will cover — the \"made up to\" date. ISO 8601 (YYYY-MM-DD)."},"dueDate":{"type":"string","example":"2026-12-31","description":"The date this filing must reach the register by. ISO 8601 (YYYY-MM-DD)."},"overdue":{"type":"boolean","example":false,"description":"Whether the register itself reports the filing as overdue. Present only when the register states it — never derived by comparing `dueDate` to today, because filing deadlines carry jurisdiction-specific grace periods. Mirrors `complianceFlags.accountsOverdue` / `complianceFlags.annualFilingOverdue`."}}},"AccountsFilingDTO":{"type":"object","properties":{"financialYearEnd":{"type":"string","example":"03-31","description":"The recurring accounting reference date as `MM-DD` (e.g. `03-31` for a 31 March year end). Not a full date — it repeats every cycle."},"lastFiled":{"description":"The most recent accounts the register has on record.","allOf":[{"$ref":"#/components/schemas/LastFilingDTO"}]},"next":{"description":"The next accounts the register expects.","allOf":[{"$ref":"#/components/schemas/NextFilingDTO"}]},"source":{"type":"string","example":"companies_house","description":"The register that reported the obligation."}}},"AnnualFilingDTO":{"type":"object","properties":{"cadence":{"type":"string","enum":["annual","biennial"],"example":"annual","description":"How often the filing falls due. Most jurisdictions are annual; several US states (Alaska, DC, Nebraska, New York) run a two-year cycle."},"lastFiled":{"description":"The most recent confirmation filing the register has on record.","allOf":[{"$ref":"#/components/schemas/LastFilingDTO"}]},"next":{"description":"The next confirmation filing the register expects.","allOf":[{"$ref":"#/components/schemas/NextFilingDTO"}]},"source":{"type":"string","example":"companies_house","description":"The register that reported the obligation."}}},"StatutoryFilingsDTO":{"type":"object","properties":{"accounts":{"description":"The statutory annual accounts obligation, when the register publishes it.","allOf":[{"$ref":"#/components/schemas/AccountsFilingDTO"}]},"annualFiling":{"description":"The periodic confirmation filing obligation, when the register publishes it (UK confirmation statement, Irish annual return, US state annual report).","allOf":[{"$ref":"#/components/schemas/AnnualFilingDTO"}]}}},"LegalFormEnum":{"type":"string","enum":["Sole Proprietorship","Partnership","Limited Liability Company","Corporation","Nonprofit Organization","Cooperative","Government-Owned Entity","Branch or Representative Office","Trust","Other"],"description":"The standardized legal form of the company."},"LegalFormDTO":{"type":"object","properties":{"localName":{"type":"string","example":"EURL, entreprise unipersonnelle à responsabilité limitée","description":"The local legal form of the company, in the local language"},"englishTranslation":{"type":"string","example":"Single Member Limited Liability Company","description":"The English translation of the local legal form."},"semaphoreStandard":{"example":"Limited Liability Company","description":"The standardized legal form of the company.","deprecated":true,"allOf":[{"$ref":"#/components/schemas/LegalFormEnum"}]},"standardized":{"example":"Limited Liability Company","description":"The standardized legal form of the company.","allOf":[{"$ref":"#/components/schemas/LegalFormEnum"}]},"iso20275Code":{"type":"string","example":"F8DD","description":"The ISO 20275 Entity Legal Form code for the company."},"isAIEnriched":{"type":"boolean","description":"True when englishTranslation, standardized, and iso20275Code were AI-inferred rather than sourced directly from the registry."}}},"MonetaryAmountDTO":{"type":"object","properties":{"amount":{"type":"number","description":"The numeric amount of money. Always a JSON number: the object is omitted entirely rather than published with an amount we cannot express as one.","example":1000},"currency":{"type":"string","description":"The ISO 4217 currency code (e.g., EUR, USD). Absent when the source states an amount without a currency, which happens on documents such as a German Gesellschafterliste. Do not discard the amount in that case: the figure is still the one the register published.","example":"EUR"},"formatted":{"type":"string","description":"Formatted string representation of the monetary amount in the local format. Falls back to the bare number when the currency is unknown.","example":"1000.00 €"}},"required":["amount","formatted"]},"EmployeeCountDTO":{"type":"object","properties":{"exact":{"type":"number","example":150,"description":"The exact number of employees, if known"},"min":{"type":"number","example":100,"description":"The minimum number of employees in a range"},"max":{"type":"number","example":200,"description":"The maximum number of employees in a range"},"lastUpdated":{"type":"string","example":"2024-03-15","description":"The date when the employee count was last updated"},"isEstimate":{"type":"boolean","example":false,"description":"Indicates if the employee count is an estimate"}}},"CompanyDTO":{"type":"object","properties":{"id":{"type":"string","description":"The id of the company, see documentation.","example":"932884117"},"countryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NB","CA-NL","CA-PE","CA-YT","CA-NT","CA-NU","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","DE-SCHUFA","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KP","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-NJ","US-NM","US-NY","US-OH","US-TX","US-DE","US-WA","US-AL","US-TN","US-WY","US-GA","US-MN","US-MO","US-NV","US-PA","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","US-NH","US-PR","TEST"],"description":"The ISO 3166-1 alpha-2 country code of the company registration country. Absent when the jurisdiction is unknown, which happens for foreign entities named by a register without one (graph nodes and corporate shareholders in particular).","example":"FR"},"identifiers":{"description":"Company identifiers such as VAT number, tax code, and registry codes. Available fields vary by country. See country-specific schemas for details.","anyOf":[{"$ref":"#/components/schemas/JapanIdentifiers","title":"JP"},{"$ref":"#/components/schemas/AntiguaBarbudaIdentifiers","title":"AG"},{"$ref":"#/components/schemas/ItalyIdentifiers","title":"IT"},{"$ref":"#/components/schemas/FranceIdentifiers","title":"FR"},{"$ref":"#/components/schemas/FrenchPolynesiaIdentifiers","title":"PF"},{"$ref":"#/components/schemas/AustriaIdentifiers","title":"AT"},{"$ref":"#/components/schemas/BelgiumIdentifiers","title":"BE"},{"$ref":"#/components/schemas/BrazilIdentifiers","title":"BR"},{"$ref":"#/components/schemas/SwitzerlandIdentifiers","title":"CH"},{"$ref":"#/components/schemas/ChinaIdentifiers","title":"CN"},{"$ref":"#/components/schemas/CyprusIdentifiers","title":"CY"},{"$ref":"#/components/schemas/CzechiaIdentifiers","title":"CZ"},{"$ref":"#/components/schemas/GermanyIdentifiers","title":"DE"},{"$ref":"#/components/schemas/DenmarkIdentifiers","title":"DK"},{"$ref":"#/components/schemas/EstoniaIdentifiers","title":"EE"},{"$ref":"#/components/schemas/FaroeIslandsIdentifiers","title":"FO"},{"$ref":"#/components/schemas/PhilippinesIdentifiers","title":"PH"},{"$ref":"#/components/schemas/FinlandIdentifiers","title":"FI"},{"$ref":"#/components/schemas/GuernseyIdentifiers","title":"GG"},{"$ref":"#/components/schemas/HongKongIdentifiers","title":"HK"},{"$ref":"#/components/schemas/CroatiaIdentifiers","title":"HR"},{"$ref":"#/components/schemas/HungaryIdentifiers","title":"HU"},{"$ref":"#/components/schemas/IcelandIdentifiers","title":"IS"},{"$ref":"#/components/schemas/IrelandIdentifiers","title":"IE"},{"$ref":"#/components/schemas/IsleOfManIdentifiers","title":"IM"},{"$ref":"#/components/schemas/JerseyIdentifiers","title":"JE"},{"$ref":"#/components/schemas/LiechtensteinIdentifiers","title":"LI"},{"$ref":"#/components/schemas/LuxembourgIdentifiers","title":"LU"},{"$ref":"#/components/schemas/LatviaIdentifiers","title":"LV"},{"$ref":"#/components/schemas/PanamaIdentifiers","title":"PA"},{"$ref":"#/components/schemas/HondurasIdentifiers","title":"HN"},{"$ref":"#/components/schemas/MexicoIdentifiers","title":"MX"},{"$ref":"#/components/schemas/ColombiaIdentifiers","title":"CO"},{"$ref":"#/components/schemas/EcuadorIdentifiers","title":"EC"},{"$ref":"#/components/schemas/BermudaIdentifiers","title":"BM"},{"$ref":"#/components/schemas/ArgentinaIdentifiers","title":"AR"},{"$ref":"#/components/schemas/ChileIdentifiers","title":"CL"},{"$ref":"#/components/schemas/UruguayIdentifiers","title":"UY"},{"$ref":"#/components/schemas/ParaguayIdentifiers","title":"PY"},{"$ref":"#/components/schemas/BoliviaIdentifiers","title":"BO"},{"$ref":"#/components/schemas/DominicanRepublicIdentifiers","title":"DO"},{"$ref":"#/components/schemas/AustraliaIdentifiers","title":"AU"},{"$ref":"#/components/schemas/KosovoIdentifiers","title":"XK"},{"$ref":"#/components/schemas/AlbaniaIdentifiers","title":"AL"},{"$ref":"#/components/schemas/TunisiaIdentifiers","title":"TN"},{"$ref":"#/components/schemas/BelizeIdentifiers","title":"BZ"},{"$ref":"#/components/schemas/NicaraguaIdentifiers","title":"NI"},{"$ref":"#/components/schemas/AnguillaIdentifiers","title":"AI"},{"$ref":"#/components/schemas/MontserratIdentifiers","title":"MS"},{"$ref":"#/components/schemas/CuracaoIdentifiers","title":"CW"},{"$ref":"#/components/schemas/MontenegroIdentifiers","title":"ME"},{"$ref":"#/components/schemas/IsraelIdentifiers","title":"IL"},{"$ref":"#/components/schemas/NorthMacedoniaIdentifiers","title":"MK"},{"$ref":"#/components/schemas/MoroccoIdentifiers","title":"MA"},{"$ref":"#/components/schemas/MonacoIdentifiers","title":"MC"},{"$ref":"#/components/schemas/MaltaIdentifiers","title":"MT"},{"$ref":"#/components/schemas/MauritiusIdentifiers","title":"MU"},{"$ref":"#/components/schemas/NewCaledoniaIdentifiers","title":"NC"},{"$ref":"#/components/schemas/NetherlandsIdentifiers","title":"NL"},{"$ref":"#/components/schemas/NorwayIdentifiers","title":"NO"},{"$ref":"#/components/schemas/PolandIdentifiers","title":"PL"},{"$ref":"#/components/schemas/PortugalIdentifiers","title":"PT"},{"$ref":"#/components/schemas/RomaniaIdentifiers","title":"RO"},{"$ref":"#/components/schemas/SerbiaIdentifiers","title":"RS"},{"$ref":"#/components/schemas/SwedenIdentifiers","title":"SE"},{"$ref":"#/components/schemas/SlovakiaIdentifiers","title":"SK"},{"$ref":"#/components/schemas/SloveniaIdentifiers","title":"SI"},{"$ref":"#/components/schemas/SpainIdentifiersDTO","title":"ES"},{"$ref":"#/components/schemas/UnitedKingdomIdentifiers","title":"GB"},{"$ref":"#/components/schemas/BVIIdentifiers","title":"VG"},{"$ref":"#/components/schemas/BosniaIdentifiers","title":"BA"},{"$ref":"#/components/schemas/BulgariaIdentifiers","title":"BG"},{"$ref":"#/components/schemas/GreeceIdentifiers","title":"GR"},{"$ref":"#/components/schemas/LithuaniaIdentifiers","title":"LT"},{"$ref":"#/components/schemas/MoldovaIdentifiers","title":"MD"},{"$ref":"#/components/schemas/RussiaIdentifiers","title":"RU"},{"$ref":"#/components/schemas/SingaporeIdentifiers","title":"SG"},{"$ref":"#/components/schemas/UkraineIdentifiers","title":"UA"},{"$ref":"#/components/schemas/CaymanIdentifiers","title":"KY"},{"$ref":"#/components/schemas/GibraltarIdentifiers","title":"GI"},{"$ref":"#/components/schemas/MarshallIslandsIdentifiers","title":"MH"},{"$ref":"#/components/schemas/CanadaFederalIdentifiers","title":"CA-FED"},{"$ref":"#/components/schemas/NewZealandIdentifiers","title":"NZ"},{"$ref":"#/components/schemas/ThailandIdentifiers","title":"TH"},{"$ref":"#/components/schemas/MongoliaIdentifiers","title":"MN"},{"$ref":"#/components/schemas/MaldivesIdentifiers","title":"MV"},{"$ref":"#/components/schemas/BahrainIdentifiers","title":"BH"},{"$ref":"#/components/schemas/SouthKoreaIdentifiers","title":"KR"},{"$ref":"#/components/schemas/TaiwanIdentifiers","title":"TW"},{"title":"US-AK","type":"object","properties":{"entityNumber":{"type":"string","description":"Alaska Entity Number: 1 to 8 digits for entities in the current numbering (e.g. 10310827, 131088). Some records carry a letter suffix after the digits; observed suffixes include D, F, H, PD and PF (e.g. 72D, 476F, 4109H, 54PD). Preserve the suffix; the list is not exhaustive. Primary identifier assigned by the Alaska Division of Corporations, Business and Professional Licensing (CBPL).","example":"10310827"},"licenseNumber":{"type":"string","description":"Alaska Business License Number: 1 to 7 digits (e.g. 2200860). This is the value returned in company.identifiers.licenseNumber. The company id of a license holder is the license number prefixed with AKBL- (e.g. AKBL-2200860). Primary identifier for sole proprietors and other business-license holders not present in the corporations register. Search results and company.id carry the AKBL- form, which keeps license numbers apart from entity numbers: use it as the id on /v2/company. The bare license number is accepted too, but a bare number is first read as an entity number. Corporation extracts and filings are not available for AKBL- license records.","example":"2200860"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-AL","type":"object","properties":{"entityId":{"type":"string","description":"Entity ID Number: 9 digits, no separators, leading zeros significant (e.g. 000358845, 001226798). The Secretary of State moved from 6-digit to 9-digit Entity IDs by adding three leading zeros to existing numbers, so older entities start with 000. The register displays the number with dashes (000-358-845). Input with dashes or without the leading zeros (358845) is also accepted. Primary identifier assigned by the Alabama Secretary of State Business Entities Division (ARC-SOS). Responses always return the 9-digit form without dashes.","example":"000358845"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-AR","type":"object","properties":{"filingNumber":{"type":"string","description":"Arkansas Filing Number: 8 or 9 digits. Observed filing numbers include 100, 200 and 811 prefixes (e.g. 200000034); the supported numeric format also admits 800 prefixes. Do not restrict validation to a list of prefixes. Primary identifier assigned by the Arkansas Secretary of State Business & Commercial Services register.","example":"811388512"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-AZ","type":"object","properties":{"entityNumber":{"type":"string","description":"Arizona Entity Number: Either 7 or 8 digits with no prefix, leading zeros significant (e.g. 01138954, 1864605, 23906030), or one letter followed by 7 or 8 digits (e.g. L10176615, F00005784, R18260883, N16431384, M0900455). Observed prefixes include F, L, M, N, P and R (e.g. P15768203); this is not an exhaustive prefix list. Primary identifier assigned by the Arizona Corporation Commission. The letter, when present, is part of the number: pass the identifier exactly as a search result returns it, without restricting letters to a fixed list. Secretary of State trade-name and trademark registrations are a separate namespace; their numbers are not interchangeable with ACC entity numbers and are not offered as a separate lookup.","example":"R18260883"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-CA","type":"object","properties":{"entityNumber":{"type":"string","description":"California Entity Number: Digits only, or B followed by 11 digits, returned without the C the register writes in front of corporation numbers and without leading zeros. Corporations: up to 7 digits (e.g. 806592, 3731484, which the register writes C0806592 and C3731484). LLCs and limited partnerships registered before 2025: 12 digits (e.g. 201806210004). Corporations, LLCs and limited partnerships registered since 2025: B followed by 11 digits (e.g. B20260142586); the B is part of the number. Primary identifier assigned by the California Secretary of State, visible on the bizfileOnline portal. Corporation numbers are accepted with or without the C prefix and leading zeros. Keep the B on numbers that have one.","example":"806592"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-CO","type":"object","properties":{"entityId":{"type":"string","description":"Colorado SOS Entity ID: Digits only, no separators. Usually 11 digits (e.g. 19931121425, 20248299164); the historical entity 1923178226 has 10 digits on both the live register and its open data. Both lengths are accepted unchanged. Primary identifier assigned by the Colorado Secretary of State business database, shown as the ID number on the entity summary page.","example":"19931121425"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-CT","type":"object","properties":{"accountNumber":{"type":"string","description":"Account Number: 7 digits, no separators, leading zeros significant (e.g. 0668349, 3453337). Primary identifier assigned by the Connecticut Secretary of the State, and the value returned as `company.id`. The composite ALEI form and a number without its leading zeros (668349) are also accepted on input.","example":"0668349"},"alei":{"type":"string","description":"ALEI (Administrative Legal Entity Identifier): Composite string US-CT.BER: followed by the 7-digit account number, leading zeros kept (e.g. US-CT.BER:0668349) The account number carrying its register prefix. This is the form shown on the public Business Records Search portal. Returned alongside the bare account number in every profile response, and accepted interchangeably on input.","example":"US-CT.BER:0668349"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-DC","type":"object","properties":{"fileNumber":{"type":"string","description":"DC File Number: The file number exactly as the register issued it, uppercase, in one of these shapes: 1 to 6 digits, leading zeros significant (e.g. 571294, 004285); one letter followed by 4 to 6 digits (e.g. L14177, C013788); one letter followed by 10 or 11 digits (e.g. L00005531281, L0000053226); two letters followed by 10 digits (e.g. AC0004848765); and, for recently registered entities, US-DC- followed by two letters and 9 digits (e.g. US-DC-LL082600020, US-DC-FN042602087). In the US-DC- form the two letters match the entity type in the records we have seen: LL domestic LLC, CO domestic corporation, NP domestic nonprofit, LP domestic limited partnership, ST domestic statutory trust, GC and LC cooperative associations, FN any foreign entity. In the older lettered forms the letter does not reliably give the entity type (many foreign LLCs carry a C number). A handful of old records carry irregular values such as 951448-4164482. Primary identifier assigned by the DC Department of Licensing and Consumer Protection. Pass it exactly as a search result returns it, including leading zeros and the US-DC- prefix where present.","example":"L00005531281"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-DE","type":"object","properties":{"fileNumber":{"type":"string","description":"Delaware File Number: Digits only, no separators and no leading zeros. In the records we have seen: 4 to 8 digits, most often 7 (e.g. 3177627) or 8 (e.g. 10171608), and shorter numbers such as 523608, 23110 or 4305. The Division of Corporations does not publish a fixed length. Primary identifier assigned by the Delaware Division of Corporations at formation. Covers all entity types registered with ICIS eCorp.","example":"3177627"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-FL","type":"object","properties":{"documentNumber":{"type":"string","description":"Document Number: Either 12 or 6 characters. 12 characters: one uppercase letter followed by 11 digits (e.g. P99000001570, L22000252360). 6 characters, on older filings: six digits (e.g. 112252) or one letter followed by five digits (e.g. A17753, G10360). The letter reflects the filing type and period, e.g. P (domestic profit corporation), L (LLC), F (foreign entity); letters in use include A, F, G, H, K, L, M, N, P, S, T and W. Primary identifier assigned by the Florida Division of Corporations. Visible on every Sunbiz entity detail page and used to look up filings on search.sunbiz.org.","example":"P99000001570"},"feiNumber":{"type":"string","description":"FEI / EIN: 9 digits issued by the U.S. Internal Revenue Service. Accepted with or without the standard hyphen (e.g. 59-0324412 or 590324412). Not all entities carry an FEI/EIN on file, so a lookup by this identifier may return no result even for an active entity. Returned in `company.identifiers.feiNumber` as the register stores it, typically with the hyphen.","example":"59-0324412"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-GA","type":"object","properties":{"controlNumber":{"type":"string","description":"Control Number: Up to 8 characters. Recent entities: 8 digits (e.g. 11078964). Older entities: 7 digits with leading zeros (e.g. 0003726), or one letter followed by 6 digits (e.g. H852680, J716207, K404041, A401954). A few legacy records carry \"0\" + a letter + 5 digits (e.g. 0F00549). The letter belongs to an older numbering series and says nothing about whether the entity is domestic or foreign. Primary identifier assigned by the Georgia Secretary of State Corporations Division (eCorp).","example":"H852680"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-HI","type":"object","properties":{"fileNumber":{"type":"string","description":"Hawaii BREG File Number: A number of up to 7 digits with no leading zeros (3 to 6 digits in the records we have seen), followed directly by a two-character suffix of one uppercase letter and one digit, with no space (e.g. 112127D1, 270541C5, 33838F1, 151D1). The suffix is the register's entity-type code, e.g. D1 Domestic Profit Corporation, C5 Domestic Limited Liability Company. The register displays the number with a space before the suffix (112127 D1); both forms are accepted on input. Primary identifier assigned by the Hawaii Business Registration Division (DCCA / BREG). The suffix is part of the identifier: a number sent without it is not recognised. Responses return the form without a space.","example":"112127D1"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-IA","type":"object","properties":{"corpNumber":{"type":"string","description":"Iowa Business Entity Number: 6 digits, numeric only, with leading zeros preserved (e.g. 084726). Primary identifier assigned by the Iowa Secretary of State, Business Services Division.","example":"084726"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-ID","type":"object","properties":{"entityNumber":{"type":"string","description":"Idaho SoS Entity Number: Digits only, up to 10, returned without leading zeros and with no prefix or separators. The records we have seen carry 3 to 7 digits (e.g. 481, 9532, 586619, 3960192). The register also shows the number zero-padded to 10 digits (e.g. 0003960192); that form is accepted too. Primary identifier assigned by the Idaho Secretary of State and shown on its SOSBiz register. Search results and company.id carry it without leading zeros. A number typed into name search is matched as free text, not as an identifier: request the company with it directly.","example":"3960192"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-IL","type":"object","properties":{"fileNumber":{"type":"string","description":"ILSOS File Number: 8 digits, leading zeros included, no separators (e.g. 08142220, 00263028). This is the value returned in company.identifiers.fileNumber. Illinois numbers corporations and LLCs in separate sequences, so one number can belong to two entities. Search results and company.id therefore carry a one-letter prefix that is ours, not the register's: C for an entity on the corporation register (including not-for-profit corporations) and L for an LLC (e.g. C08142220, L02664844). Primary identifier assigned by the Illinois Secretary of State, Department of Business Services. Use the prefixed id from search results on /v2/company. A bare 8-digit number is accepted too, but when it matches both a corporation and an LLC the request is refused and the prefixed form is required.","example":"08142220"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-IN","type":"object","properties":{"entityNumber":{"type":"string","description":"Indiana Business Entity Number: Several formats, by period: 13 to 16 digits (e.g. 2001111900027, 202406111799031); 8 to 12 digits (e.g. 1997051343); a legacy form of 6 digits, then a hyphen or a letter, then 3 digits (e.g. 183025-143, 193046A080); and LP followed by 8 digits for older limited partnerships (e.g. LP93120064). All formats are accepted for search. Primary identifier assigned by the Indiana Secretary of State Business Services Division (BSD). The format reflects the era of formation.","example":"183025-143"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-KS","type":"object","properties":{"businessId":{"type":"string","description":"Kansas SoS Business ID: Numeric, no dashes or spaces. 6 to 8 digits in the records we have seen; none of those sampled IDs had a leading zero (e.g. 602771, 2444669, 10049404). Distinct from the Federal Employer Identification Number (FEIN). Primary identifier assigned by the Kansas Secretary of State Business Services Division. The observed lengths are not an exhaustive register specification. The portal has never issued or echoed an ID with a leading zero; a zero-padded input (e.g. 0602771) resolves to the same entity as its unpadded form (602771). Preserve the returned ID exactly as given; do not pad it to a fixed width.","example":"2444669"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-KY","type":"object","properties":{"organizationNumber":{"type":"string","description":"Kentucky Organization Number: 7 digits, leading zeros included, no prefix or separators (e.g. 0061792, 1255687). A number sent without its leading zeros (e.g. 61792) is padded to 7 digits. Primary identifier assigned by the Kentucky Secretary of State, Business Filings division. An entity and its assumed names share one Organization Number, which resolves to the entity itself.","example":"0061792"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-LA","type":"object","properties":{"charterNumber":{"type":"string","description":"Louisiana Charter Number: 9 characters: 8 digits followed by one uppercase letter, no separators. Leading zeros are part of the number (e.g. 29504510F, 36528934K, 03002150N). Letters in the records we have seen: D, F, K, L, N and X. Primary identifier assigned by the Louisiana Secretary of State, Commercial Division, which documents it as 8 digits plus one letter. Send all 9 characters.","example":"29504510F"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MA","type":"object","properties":{"maSocId":{"type":"string","description":"MA Secretary of the Commonwealth Entity ID: 9 digits, leading zeros included, no separators (e.g. 000804945, 041543470). Some trusts carry the letter T followed by 8 digits instead (observed). Primary identifier assigned by the Massachusetts Secretary of the Commonwealth, Corporations Division, shown on the register as the Identification Number. Send it with its leading zeros.","example":"000804945"},"dlsId":{"type":"string","description":"DLS Synthetic Identifier: 12 lowercase hexadecimal characters (e.g. 19dcdd187b79). Not a register number: it is derived from the entity name and city listed in the annual Corporations Book of the Division of Local Services, so it changes when either changes in a later edition. Returned as the id of name-search results, and accepted as a search query and on /v2/company. Company profiles carry the official maSocId instead: keep that one.","example":"19dcdd187b79"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MD","type":"object","properties":{"departmentId":{"type":"string","description":"SDAT Department ID: One uppercase letter followed by 8 digits, no separators (e.g. D22958060, W05989793, T00371146). SDAT documents that the letter corresponds to the entity type: D (Maryland corporation, stock or non-stock), F (foreign corporation), W (Maryland LLC), Z (foreign LLC), M and P (Maryland and foreign limited partnership), A and E (Maryland and foreign LLP), B and S (Maryland and foreign statutory trust), L (sole proprietorship or general partnership), T (trade name). Primary identifier assigned by the Maryland State Department of Assessments and Taxation (SDAT), served via the Maryland Business Express portal. An entity that converts to another entity type receives a new Department ID. Trade names (T) appear in name search results but the register publishes no company record for them, so they cannot be retrieved on /v2/company.","example":"D22958060"},"businessCode":{"type":"string","description":"SDAT Business Code: Two-digit code followed by a descriptive label (e.g. \"04 ORDINARY BUSINESS - NON-STOCK\") Secondary SDAT classification code published on the entity detail page. Not present for all entities.","example":"04 ORDINARY BUSINESS - NON-STOCK"},"stateOfFormation":{"type":"string","description":"State of formation: Free text, as published by SDAT State where the entity was originally formed. Returned only when the register publishes it.","example":"MARYLAND"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-ME","type":"object","properties":{"charterNumber":{"type":"string","description":"Maine Charter Number: 8 or 9 digits followed by a one- or two-letter entity-type suffix. A two-letter suffix follows the digits directly (e.g. 19970058LP, 202509124DC); a one-letter suffix is preceded by a space (e.g. 19340021 D, 202500963 F). The Secretary of State documents these suffixes: D, B, RR, CP and I (Maine business corporation), F (foreign business corporation), ND and NF (Maine and foreign nonprofit corporation), DC and FC (Maine and foreign LLC), LP and LF (Maine and foreign limited partnership), DP and FP (Maine and foreign LLP). Other suffixes appear in the records we have seen (e.g. GP). Unique, constant identifier assigned by the Maine Secretary of State to each entity. Accepted with or without the space before a one-letter suffix; responses keep the space.","example":"19970058LP"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MI","type":"object","properties":{"miIdNumber":{"type":"string","description":"Michigan LARA Identification Number: 9 digits, no prefix or separators (e.g. 800853791, 801056837, 900145929). Primary identifier assigned by the Michigan Department of Licensing and Regulatory Affairs (LARA) Corporations Division. Printed on every filing and shown on the MiBusiness Registry entity detail page. Michigan assigned these 9-digit numbers in 2017, replacing the older six-character IDs: send the 9-digit number.","example":"800853791"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MN","type":"object","properties":{"fileNumber":{"type":"string","description":"Minnesota File Number: Variable length, digits and uppercase letters, with at most one internal dash. The register documents that a file number may contain dashes and letters; both are part of the number. Recent filings carry a long all-digit number, 12 or 13 digits in the records we have seen (e.g. 631180100027, 1543060200024); the register allows up to 21 characters. Older filings carry shorter numbers: all digits (e.g. 5451, 68758) or letters and digits around a dash (e.g. 11-AA, 1K-1056, 886-NPA, 4V-200). Accepted in any letter case. Primary identifier assigned by the Minnesota Secretary of State (Minnesota Business & Lien System, MBLS). Name search results do not carry it: their id is the MBLS Filing GUID (see filingGuid). A file number is not unique on its own: the register treats file number and business type together as the unique key, and the same number can belong to entities of different types (e.g. 4912 is both an assumed name and a trademark). When a file number matches more than one entity, look the company up by its Filing GUID.","example":"631180100027"},"filingGuid":{"type":"string","description":"MBLS Filing GUID: 36 characters: 32 lowercase hexadecimal digits in groups of 8, 4, 4, 4 and 12, separated by hyphens (e.g. e4d83ed9-ae4b-e211-bc43-001ec94ffe7f). It has the layout of a UUID but does not follow the UUID version rules (the first digit of the third group is e or f in the records we have seen), so validate the pattern, not a UUID version. Accepted in any letter case. Identifier of the entity record on the MBLS portal. It is the id of every name search result and always resolves to a single entity: pass it as the id on /v2/company. Returned in company.identifiers when available and accepted as a search input.","example":"e4d83ed9-ae4b-e211-bc43-001ec94ffe7f"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MO","type":"object","properties":{"entityId":{"type":"string","description":"Missouri Business Identification Number (BIN): Two register forms. Observed prefixed charter numbers have one or two letters followed by 7 to 9 digits (e.g. F00214431, LC1026096, LC014399166, N00024686). The letters are the register filing category: F (for-profit corporation), LC (domestic LLC), FL (foreign LLC), N (non-profit corporation), LP (limited partnership), H (credit union), K (bank), B (benevolent corporation), O (insurance company), X (fictitious name); the list is not closed. Some for-profit corporations carry 8 digits with no prefix, leading zeros included (e.g. 00333672). Search-result ids may also be MOBSD- followed by the numeric portal record number (e.g. MOBSD-551157); this Topograph id is not a BIN. Primary identifier assigned by the Missouri Secretary of State (BSD). Name search returns the charter number for its first results; the others come back under a Topograph id, MOBSD- followed by the register record number (e.g. MOBSD-551157). Send that id to /v2/company as is: the response carries the charter number as company.id. Leading zeros in a BIN are significant. Bare 8-digit numbers are read as BINs, never as portal record numbers; a record number requires MOBSD-.","example":"F00214431"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MS","type":"object","properties":{"businessId":{"type":"string","description":"Business ID: Digits only, no separators and no leading zeros. 6 or 7 digits in the records we have seen (e.g. 104297, 1001743). Unique identifier assigned by the Mississippi Secretary of State to each registered business entity.","example":"104297"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-MT","type":"object","properties":{"entityId":{"type":"string","description":"Montana SoS File Number: One or two uppercase letters followed by 6 or 7 digits, no separator, leading zeros included (e.g. F022568, C1548288, RN1064026). In the records we have seen: C (domestic LLC), E (foreign LLC), D (domestic corporation, profit or nonprofit, e.g. D002784, D1137652), F (foreign corporation), L (limited partnership), A (assumed business name) and RN (name reservation); P and N are also in use. The list is not closed. State correspondence may print the number with a hyphen after the letter (D-123456); the API returns it without. Primary identifier assigned by the Montana Secretary of State at entity formation or qualification, published on the biz.sosmt.gov portal as the Filing Number. Pass it without a hyphen, exactly as a search result returns it.","example":"F022568"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NC","type":"object","properties":{"sosId":{"type":"string","description":"SOS ID: Exactly 7 digits, no separators, left-padded with zeros (e.g. 0027238, 3395486). Every id in the records we have seen has 7 digits. Primary identifier assigned by the North Carolina Secretary of State at entity formation or qualification, called the Secretary of State Identification Number (SOSID) on sosnc.gov. Search and company lookups also accept the number without its leading zeros.","example":"0027238"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-ND","type":"object","properties":{"entityId":{"type":"string","description":"SOS Control ID#: Exactly 10 digits, no separators, left-padded with zeros (e.g. 0000071213, 0007382449). Every id in the records we have seen has 10 digits. Primary identifier assigned by the North Dakota Secretary of State at filing time. Unique across all filing types (corporations, LLCs, trade names, trademarks, reserved names). Search and company lookups also accept the number without its leading zeros.","example":"0000071213"},"ndInternalId":{"type":"string","description":"FirstStop Internal ID: Digits only, no padding (e.g. 70993). A different number from the SOS Control ID#: the two cannot be derived from each other. Portal-internal identifier used by the FirstStop system to navigate to the entity detail page. Not a public register identifier.","example":"70993"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NE","type":"object","properties":{"accountNumber":{"type":"string","description":"SOS Account Number: Digits only, no separators. Three lengths in the records we have seen: 7 digits, often starting with zeros that are part of the number (e.g. 0527041, 1274939), 8 digits (e.g. 10214668) and 10 digits (e.g. 2103077754). Primary identifier assigned by the Nebraska Secretary of State, Business Services Division. Pass it exactly as a search result returns it, leading zeros included.","example":"10214668"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NH","type":"object","properties":{"entityId":{"type":"string","description":"NH Business ID: Letters and digits, no separators. Most entities: digits only, variable length, no leading zeros; 5 to 7 digits in the records we have seen (e.g. 39831, 848218, 1026301). Some older corporations: the letter B followed by 5 digits (e.g. B02109), sometimes with a trailing letter (e.g. B55857A). Primary identifier assigned by the New Hampshire Department of State at filing time, also called the Charter Number. Unique across all entity types: corporations, limited liability companies, limited partnerships, trade names and trademarks share the same number space. Pass it exactly as a search result returns it, including every letter of a B-prefixed ID.","example":"848218"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NJ","type":"object","properties":{"entityId":{"type":"string","description":"NJ Entity ID: Exactly 10 digits, no separators. Leading zeros are part of the number: most ids we have seen start with 0 (e.g. 0100307257, 0400276378), some do not (e.g. 6444850000). The register does not accept a shortened form. Primary identifier assigned by the New Jersey Division of Revenue and Enterprise Services (DORES). Used to look up filings on the DORES public portal and to order business records.","example":"0100307257"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NM","type":"object","properties":{"businessId":{"type":"string","description":"NM SOS Business ID: Observed forms, none with separators. Most entities: 3 to 10 digits, where modern IDs are zero-padded to 10 digits and the leading zeros are significant (e.g. 913, 1166917, 0008058504). Many partnerships: a letter prefix followed by 10 digits (e.g. LPD2005092001); prefixes in use are LPD and LPF (limited partnership, domestic and foreign), GPD (general partnership), LLD (limited liability partnership), LLLD and LLLF (limited liability limited partnership, domestic and foreign). Some older limited partnerships: 4 digits followed by NM (e.g. 0806NM). Historical bank records also carry 3 or 4 digits followed by A (e.g. 323A, 2352A). Primary identifier assigned by the New Mexico Secretary of State and published on the register as the Business ID. Pass it exactly as a search result returns it. The register does not resolve the observed NM-suffixed and A-suffixed numbers through its ID search: those records appear in name search results, but company lookup by those IDs and documents are currently unavailable. Trade Register Extracts are available for numeric IDs of 3 to 10 digits and letter-prefixed partnership IDs.","example":"2070134"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NV","type":"object","properties":{"entityNumber":{"type":"string","description":"Entity Number: An uppercase letter prefix, digits, a hyphen and a numeric suffix, no spaces. Two forms in the records we have seen. Current numbering: E followed by 10 or 11 digits, a hyphen and 1 digit (e.g. E0082262010-4, E40614102024-7). Older entities: a letter prefix (C, LLC and LP seen so far), up to 5 digits, a hyphen and 4 digits (e.g. C40-1921, C14059-2002, LLC1688-2002, LP38-1987). The register publishes no list of prefixes, so treat the set as open. Primary identifier assigned by the Nevada Secretary of State and shown as the Entity Number on the register. Pass it exactly as a search result returns it: the letters and the hyphenated suffix are part of the number.","example":"LLC1688-2002"},"nvBusinessId":{"type":"string","description":"NV Business ID: NV followed by 11 digits, no separators (e.g. NV20021018811). Cross-agency identifier shared between the Secretary of State and the Nevada Department of Taxation. Not present on all entities.","example":"NV20021018811"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-NY","type":"object","properties":{"dosId":{"type":"string","description":"DOS ID: Numeric, 1 to 7 digits, no leading zeros. Most entities have 6 or 7 digits; the oldest have fewer (e.g. 3707). Primary identifier assigned by the New York Department of State Division of Corporations. Visible on every NY DOS Public Inquiry entity detail page and used to look up filings on data.ny.gov.","example":"2494465"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-OH","type":"object","properties":{"ohioId":{"type":"string","description":"Ohio Charter / Entity Number: Observed numeric forms: 4 to 7 digits; none of the sampled numeric IDs had a leading zero (e.g. 1456, 693950, 2420083). Registered trade names and a few older or special registrations carry letters: two letters followed by digits (e.g. RN228652, FN31251, LP3159), or digits followed by one letter (e.g. 14276Z). Primary identifier assigned by the Ohio Secretary of State. Corresponds to the charter_num field on the public business search portal (businesssearch.ohiosos.gov) and the charter number column in the monthly Business Reports. These are observed formats, not an exhaustive register specification. Preserve the returned string, including its letters and any leading zeros; do not pad it to a fixed width.","example":"1067403"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-OK","type":"object","properties":{"filingNumber":{"type":"string","description":"Filing Number: 10 digits, numeric only Primary identifier assigned by the Oklahoma Secretary of State. Displayed on every entity page at sos.ok.gov/corp and used for all register lookups.","example":"3400676484"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-OR","type":"object","properties":{"registryNumber":{"type":"string","description":"Registry Number: Digits, with a hyphen before the last 2 digits for most entities; 3 to 9 digits in total. Most entities: 6 or 7 digits, a hyphen and 2 digits, where the part before the hyphen is zero-padded to 6 digits (e.g. 087399-14, 1496294-95). Some search results carry that part without its leading zero (e.g. 12267-11 for 012267-11). Some entities: 3 to 6 digits with no hyphen (e.g. 414, 443499). The register's open data stores the same numbers as digits only, without the hyphen or leading zeros (e.g. 8739914). Primary identifier assigned by the Oregon Secretary of State Corporation Division and shown as the Registry Number on the Oregon Business Registry. Accepted with or without the hyphen and leading zeros (087399-14, 08739914 and 8739914 resolve to the same entity); responses use the hyphenated form, or the plain digits for numbers under 7 digits.","example":"087399-14"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-PA","type":"object","properties":{"filingNumber":{"type":"string","description":"PA Filing Number: 10 digits, numeric only, with leading zeros preserved (e.g. 0004272272). Primary identifier assigned by the Pennsylvania Department of State. Used to look up entity detail on the Business Filing Services portal and to search the open-data register at data.pa.gov.","example":"0004272272"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-PR","type":"object","properties":{"registrationIndex":{"type":"string","description":"Puerto Rico Department of State register number with suffix: The register number (1 to 6 digits with no leading zeros in the records we have seen), a hyphen, then a suffix. Observed suffixes include a single digit group (e.g. 59124-111, 61-1531, 9-611), several digit groups separated by hyphens or underscores (e.g. 134-12-2-2, 62-1221_1), and, on some migrated records, an empty suffix (e.g. 7620-). Unique per entity. The register number alone can be shared by several unrelated entities, so keep the complete identifier, including all hyphen and underscore suffix segments and a trailing hyphen when the suffix is empty.","example":"59124-111"},"registerNumber":{"type":"string","description":"Puerto Rico Department of State register number (Register No.): 1 to 6 digits with no leading zeros in the records we have seen (e.g. 59124). The number the register displays and prints. It is not unique: a search by this number returns every entity that carries it, each with its own suffixed identifier.","example":"59124"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-RI","type":"object","properties":{"identificationNumber":{"type":"string","description":"RI Identification Number: Nine-digit zero-padded number (e.g. 000015908) Primary identifier assigned by the Rhode Island Department of State Business Services Division to each entity in the Corporate Database.","example":"000015908"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-SC","type":"object","properties":{"guid":{"type":"string","description":"SC SoS Entity GUID: UUID (8-4-4-4-12 hex, lowercase), assigned by the SC Secretary of State Business Entities Online portal and used as the URL key on every entity profile page. Primary identifier assigned by the SC Secretary of State Business Entities Online portal. Visible in every entity profile URL at businessfilings.sc.gov and used for direct entity lookups.","example":"e6980025-c7ec-4715-8bf0-52b5ef0c585f"},"entityId":{"type":"string","description":"SC SoS Entity Id: 8-digit zero-padded integer displayed on the entity profile page. Not accepted as a search input by the public portal. Printed on filed paper documents; returned in `company.identifiers.entityId` so customers can reconcile against their own paperwork. NOT accepted as a lookup input: the SC portal search matches entity names only, so Topograph API calls use the GUID.","example":"00121743"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-SD","type":"object","properties":{"businessId":{"type":"string","description":"Business ID: Exactly 8 characters, no separators: two uppercase letters followed by 6 digits, leading zeros included (e.g. FB033693, DL025748, NS000956). Prefixes seen in our search results: DL, NS, DB, FB, FL, FP, FK, BK, CH, DP, DR, RN, RS, DM, DT, GP and FN; the list is not closed. The register does not publish what the letters mean. Primary identifier assigned by the South Dakota Secretary of State and shown as the Business ID on the register. Pass it exactly as a search result returns it: the two letters and the leading zeros are part of the number.","example":"FB033693"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-TN","type":"object","properties":{"controlNumber":{"type":"string","description":"Control Number: 9-digit zero-padded number assigned by the Tennessee Secretary of State at registration. Accepted as 9 consecutive digits (000239194) or without leading zeros (239194). Primary identifier assigned by the Tennessee Secretary of State. Visible on every entity detail page at tncab.tnsos.gov.","example":"000239194"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-TX","type":"object","properties":{"taxpayerId":{"type":"string","description":"Texas Taxpayer Number: 11 digits, no separators. The first digit is 1 when the number is built on the entity's federal EIN (the next nine digits are the EIN, e.g. 17307175087) and 3 when the Comptroller assigned it (e.g. 32041800429, 30003761332). The last digit is a check digit. Primary identifier assigned by the Texas Comptroller of Public Accounts. Used as the lookup key for both the Franchise Tax and Sales Tax Comptroller systems. Every search result id is a taxpayer number, whichever identifier was searched: use it on /v2/company.","example":"17307175087"},"sosFileNumber":{"type":"string","description":"SOS Filing Number: 10 digits, zero-padded, leading zeros included (e.g. 0803367205, 0003077806). The Secretary of State displays the same number without the leading zeros (803367205, 3077806). In the records we have seen, recent filings start with 080. Filing number assigned by the Texas Secretary of State. Only present for formal entities (corporations, LLCs, limited partnerships and similar); absent for sole traders and sales-tax-only taxpayers. Search accepts it padded or as the Secretary of State displays it (0803367205 or 803367205, 0003077806 or 3077806). The search result id is the taxpayer number.","example":"0003077806"},"feiNumber":{"type":"string","description":"Federal Employer Identification Number: The 9-digit federal EIN as recorded by the Comptroller, without a separator (e.g. 730717508). For a taxpayer number that starts with 1, it is normally the second to tenth digits of that number. Federal Employer Identification Number (FEIN / EIN) as recorded in the Texas Comptroller and Secretary of State systems. Only present when the entity has a FEIN on file; absent for sole traders who registered without one.","example":"730717508"},"stateOfFormation":{"type":"string","description":"State of Formation: Two-letter US state code or \"TX\" for domestic entities (e.g. TX, NJ, DE) US state in which the entity was originally formed, as recorded in the Franchise Tax system. Only present when reported by the Comptroller.","example":"TX"},"sosRegistrationStatus":{"type":"string","description":"SOS Registration Status: Short status string from the Comptroller (e.g. ACTIVE, INACTIVE, NOT REGISTERED) Raw SOS registration status label from the Texas Comptroller Franchise Tax system, returned in prefill mode. Redundant with the top-level company status field but included here for completeness when present.","example":"ACTIVE"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-UT","type":"object","properties":{"entityNumber":{"type":"string","description":"Utah Entity Number: 6 to 8 digits, a hyphen, then 4 digits, with no letters (e.g. 616169-0140, 7228568-0140, 10110445-0143). The four digits after the hyphen follow the entity type: in the records we have seen, -0140 is a domestic nonprofit corporation, -0151 an assumed name (DBA) and -0181 a foreign limited partnership; other values in use include -0141, -0142, -0143, -0150, -0160 and -0161, and the list is not closed. Primary identifier assigned by the Utah Division of Corporations & Commercial Code and shown as the Entity Number on businessregistration.utah.gov. Every id we return carries the hyphen and the four-digit suffix; the digits before the hyphen alone are also accepted as input.","example":"616169-0140"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-VA","type":"object","properties":{"entityId":{"type":"string","description":"SCC ID: 8 characters, no separators, in two forms. One uppercase letter followed by 7 digits (e.g. S0381378, T0479784, F1389198, L0007460, M0093452). Or 8 digits with leading zeros kept (e.g. 02937985, 00003145, 11127380): older corporations carry this form, and so do recent registrations of every entity type, LLCs and limited partnerships included. In the records we have seen, the letter follows the filing family: S (Virginia LLC), T (foreign LLC), F (foreign corporation), L (Virginia limited partnership, and some LLCs), M (foreign limited partnership), J (a few LLCs). The register publishes no meaning for the letters, and the list is not closed. Primary identifier assigned by the Virginia State Corporation Commission, shown as the Entity ID (or SCC ID) in the Clerk's Information System at cis.scc.virginia.gov. Pass it exactly as a search result returns it, letter and leading zeros included.","example":"02937985"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-VT","type":"object","properties":{"entityId":{"type":"string","description":"Record Number: Always 6 digits, zero-padded, leading zeros included (e.g. 074657, 001020, 487831). Primary identifier assigned by the Vermont Secretary of State when the entity is filed. Unique across all filing types (corporations, LLCs, partnerships, assumed names, etc.). Accepted with or without the leading zeros; every id we return carries the 6-digit form.","example":"074657"},"vtIdBusiness":{"type":"string","description":"VT Internal Business ID: UUID, 36 characters with hyphens, lowercase in the records we have seen (e.g. 79304417-fb3e-4bd0-8dda-1a005071a37a) The register's internal key for the entity, returned alongside the Record Number for reference. It cannot be used to search or to request a company: use the Record Number.","example":"79304417-fb3e-4bd0-8dda-1a005071a37a"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WA","type":"object","properties":{"ubi":{"type":"string","description":"UBI (Unified Business Identifier): Always 9 digits, returned without separators (e.g. 600413485, 606026013, 178005030). The register displays it in groups of three (600 413 485); search and company requests also accept the dashed form (600-413-485). The same UBI cross-references the entity across the Secretary of State, Department of Revenue, Labor & Industries, and Employment Security. Primary identifier assigned by the Washington Business Licensing Service.","example":"600413485"},"fein":{"type":"string","description":"FEIN (Federal Employer Identification Number): The 9-digit federal EIN as recorded on the Secretary of State entity profile (e.g. 911144442) Returned when present on the Secretary of State entity profile. Not all entities carry a FEIN.","example":"911144442"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WI","type":"object","properties":{"entityId":{"type":"string","description":"Wisconsin DFI Entity ID: Seven characters: one alpha plus six numerics, accepted in two shapes : modern `A######` (one letter then six digits) or legacy `#A#####` (one digit, one letter, then five digits). Primary identifier assigned by the Wisconsin Department of Financial Institutions. Visible on every WDFI Corporate Records Search entity detail page.","example":"K024598"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WV","type":"object","properties":{"orgNumber":{"type":"string","description":"WV Organization Number: Digits only, with no leading zeros, letters or separators. In the records we have seen it has 4 to 6 digits (e.g. 2011, 20122, 633785). Primary identifier assigned by the West Virginia Secretary of State (the \"Org Id\"). Used to key the entity detail page directly on the Online Data Services portal.","example":"20122"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}},{"title":"US-WY","type":"object","properties":{"filingId":{"type":"string","description":"Filing ID: YYYY-NNNNNNNNN: a 4-digit year prefix, a dash, and a 9-digit zero-padded sequence number issued by the Wyoming Secretary of State upon entity registration. Primary identifier assigned by the Wyoming Secretary of State. Visible on every WyoBiz entity detail page and used as the lookup key on wyobiz.wyo.gov.","example":"2004-000464709"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI): 20 uppercase alphanumeric characters, ending with 2 digits Returned when a company identifier uniquely matches a GLEIF registration or validation reference. Coverage varies by jurisdiction and entity. Lapsed and retired LEIs may be returned; annulled LEIs are excluded.","example":"96950066U5XAAIRCPA78"}}}]},"listedSecurities":{"description":"Positive securities evidence matched to this issuer by LEI. Coverage is limited to ESMA- and FCA-reported, issuer-approved equity or fund-unit admission or trading on active ISO RMKT venues. UK venues use FCA evidence. Multiple securities and markets may be returned. This is not a complete worldwide inventory or a determination of formal listing or AML eligibility. Absent when no evidence is established, the issuer cannot be matched, or the supplementary source is unavailable; absence does not mean unlisted.","type":"array","items":{"$ref":"#/components/schemas/ListedSecurityDTO"}},"taxId":{"description":"Tax identification number, with verification status and proof when available. For EU VAT, the value does NOT include the country prefix (e.g., \"64443061841\" not \"FR64443061841\").","allOf":[{"$ref":"#/components/schemas/TaxIdDTO"}]},"legalName":{"type":"string","example":"Topograph","description":"The legal name of the company."},"legalNameInEnglish":{"type":"string","example":"Test Display Hong Kong Trading Limited","description":"The English translation or romanization of the legal name, commonly used for international business. Particularly relevant for companies registered with non-Latin alphabet names (e.g., Chinese, Japanese, Korean, etc.)."},"commercialNames":{"example":["Topograph","TopographHQ"],"description":"An array of commercial names or trading names used by the company.","type":"array","items":{"type":"string"}},"legacyLegalNames":{"example":["Semaphore","SemaphoreHQ"],"description":"An array of legacy legal names used by the company.","type":"array","items":{"type":"string"}},"legacyCommercialNames":{"example":["Semaphore","SemaphoreHQ"],"description":"An array of legacy commercial names used by the company.","type":"array","items":{"type":"string"}},"companyNameTransliterations":{"example":["Naftogaz","Naftohaz"],"description":"Deterministic Latin transliterations of the company’s legal and commercial names, computed at indexing time using per-country transliteration standards. For Ukrainian entities this contains up to three deduped variants (GOST/unidecode, KMU 55, ISO 9). Element [0] aligns with the output of the generic `?transliterate=true` response flag. Useful for cross-script display, search, and AML name screening. Absent or empty for Latin-script companies and for non-Latin countries not yet covered (phased rollout).","type":"array","items":{"type":"string"}},"status":{"description":"The status of the company, including local status and whether it is active.","allOf":[{"$ref":"#/components/schemas/CompanyStatusDTO"}]},"complianceFlags":{"description":"Country-agnostic compliance signals reported by the register, keyed by kind (statutory accounts or the annual confirmation filing being overdue, registered charges, insolvency history, past liquidation). Each kind has its own dedicated schema and is present only when the register formally reports on that signal, with `active` carrying the register’s answer — so `active: false` means the register says no, while an absent key means no formal statement either way. Absent entirely for countries that do not expose such signals.","allOf":[{"$ref":"#/components/schemas/ComplianceFlagsDTO"}]},"statutoryFilings":{"description":"The periodic filing obligations the register holds the company to: the statutory annual accounts and the confirmation/annual filing, each with the period last filed and the one next due. Cross-country — the same two obligations exist under different local names (UK confirmation statement, Irish annual return, US state annual report). A slot is present only when the register publishes it, and sub-fields are independently optional because registers publish different subsets.","allOf":[{"$ref":"#/components/schemas/StatutoryFilingsDTO"}]},"registrationDate":{"type":"string","example":"2024-04-22","description":"The registration date of the company with the trade register or other authorities."},"incorporationDate":{"type":"string","example":"2024-04-15","description":"The incorporation date when the company was legally incorporated or founded. This may differ from the registration date, as companies are often incorporated before being registered with trade authorities."},"legalForm":{"description":"The legal form of the company, including local and standard forms.","allOf":[{"$ref":"#/components/schemas/LegalFormDTO"}]},"capital":{"description":"The share capital of the company.","allOf":[{"$ref":"#/components/schemas/MonetaryAmountDTO"}]},"activities":{"type":"object","description":"A dictionary of activity classifications","example":{"NACE":[{"code":"62.01","description":"Computer programming activities"}],"ISIC":[{"code":"J620","description":"Computer programming, consultancy and related activities"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}}},"activityDescription":{"type":"string","description":"A text description of the company activities","example":"Development of software solutions and IT consulting services"},"legalAddress":{"description":"The address of the company.","allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"phones":{"example":["+33123456789","+33987654321"],"description":"An array of phone numbers for the company in E.164 format (e.g., +33123456789 for France, +1234567890 for USA).","type":"array","items":{"type":"string"}},"website":{"type":"string","example":"https://www.example.com","description":"The official website URL of the company."},"employeeCount":{"description":"The employee count information for the company.","allOf":[{"$ref":"#/components/schemas/EmployeeCountDTO"}]}}},"PersonNameDTO":{"type":"object","properties":{"title":{"type":"string","description":"Title of the person (e.g., Mr., Mrs., Dr.)"},"firstName":{"type":"string","description":"First name of the person"},"middleName":{"type":"string","description":"Middle name of the person"},"lastName":{"type":"string","description":"Last name of the person"},"fullName":{"type":"string","description":"Full name of the person"},"suffix":{"type":"string","description":"Suffix of the name (e.g., Jr., Sr., III)"}},"required":["fullName"]},"BirthDateDTO":{"type":"object","properties":{"day":{"type":"number","description":"Day of birth (1-31)","example":15},"month":{"type":"number","description":"Month of birth (1-12), where January is 1","example":7},"year":{"type":"number","description":"Year of birth","example":1980}}},"RangeDto":{"type":"object","properties":{"lower":{"type":"number","description":"Lower bound of the range","example":25},"upper":{"type":"number","description":"Upper bound of the range","example":50}},"required":["lower","upper"]},"PercentageDetailDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of percentage detail (shares, voting rights)","enum":["shares","voting-rights"],"example":"shares"},"percentageRange":{"description":"Range of control as a lower and upper bound","example":{"lower":25,"upper":50},"allOf":[{"$ref":"#/components/schemas/RangeDto"}]},"percentageValue":{"type":"number","description":"Exact percentage of control","example":30},"monetaryAmount":{"description":"Monetary amount of shares controlled","allOf":[{"$ref":"#/components/schemas/MonetaryAmountDTO"}]},"numberOfShares":{"type":"number","description":"Number of shares controlled","example":1000},"nature":{"type":"string","description":"Indicates whether the control is direct or indirect. `null` when the source states the control but not its nature, which several registers never disambiguate (the Belgian UBO register, the German Transparenzregister, and UK PSC statements that carry no indirect marker). Absent when the source says nothing about nature at all. Those are different facts, so do not collapse them.","enum":["direct","indirect",null],"nullable":true,"example":"direct"}},"required":["type"]},"ControlDTO":{"type":"object","properties":{"types":{"type":"array","description":"Types of control held by the beneficial owner","items":{"type":"string","enum":["ownership-of-shares","voting-rights","appoint-and-remove-directors","significant-influence-or-control"]},"example":["ownership-of-shares"]},"description":{"type":"string","description":"Description of why the person is of significant control. Absent when the source gives no narrative and none can be derived from `types`.","example":"The person holds more than 50% of the shares in the company."},"details":{"description":"Details about the percentage of control","type":"array","items":{"$ref":"#/components/schemas/PercentageDetailDto"}},"isFallback":{"type":"boolean","description":"`true` when the register lists this person only as a fallback: no natural person owns or controls the company, so the law names its senior managing officials (legal representatives, managing partners) as beneficial owners instead. In Germany these are the *fiktive wirtschaftlich Berechtigte* of § 3 Abs. 2 S. 5 GwG. `false` when the register records the person as a real owner or controller. Absent when the source does not say, which is the case for most countries today.","example":false}},"required":["types"]},"UltimateBeneficialOwnerDTO":{"type":"object","properties":{"gender":{"type":"string","description":"Gender of the person","enum":["Male","Female","Other","PreferNotToSay"],"example":"Female"},"name":{"description":"Full name of the person","example":{"fullName":"John Doe"},"allOf":[{"$ref":"#/components/schemas/PersonNameDTO"}]},"birthDate":{"description":"Birth date of the person","example":{"day":15,"month":7,"year":1980},"allOf":[{"$ref":"#/components/schemas/BirthDateDTO"}]},"birthAddress":{"description":"Birth address of the person","example":{"country":"FR","city":"Paris","street":"1 Rue de Rivoli","postalCode":"75001"},"allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"nationality":{"type":"string","description":"Nationality ISO2 country code of the person","example":"US"},"residenceAddress":{"description":"Residence address of the person","allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"identifiers":{"type":"object","description":"Identifiers for the person, as a flat object keyed by identifier type (e.g., codice fiscale, national ID). Each value is the identifier string.","additionalProperties":{"type":"string"},"example":{"codiceFiscale":"RSSMRA80A01H501U"}},"entityId":{"type":"string","description":"Unique identifier to track the same person or company across different roles (legal representatives, shareholders, UBOs, etc.). Since data is retrieved from multiple registries, the same entity may appear with slightly different names or details. This ID allows you to identify that \"John Smith\" as a legal representative is the same person as \"J. Smith\" listed as a shareholder.","example":"person_001"},"control":{"description":"Details of control held by the beneficial owner","example":{"types":["ownership-of-shares"],"description":"The person holds more than 50% of the shares in the company.","details":[{"type":"shares","percentageValue":50,"nature":"direct"}]},"allOf":[{"$ref":"#/components/schemas/ControlDTO"}]}}},"RoleEnum":{"type":"string","enum":["Director","Manager","Employee","Chief Executive Officer","Chief Financial Officer","Chief Operating Officer","President","Vice President","Secretary","Treasurer","Legal Advisor","General Counsel","Partner","Associate","Other","Chairman of the Board","Vice Chairman of the Board","Board Member","Managing Director","Executive Director","Non-Executive Director","General Partner","Managing Partner","Limited Partner","Administrator","Liquidator","Receiver","Owner","Chairman","Auditor","Authorized Signatory"],"description":"The standardized role of the individual."},"RoleDTO":{"type":"object","properties":{"localName":{"type":"string","description":"The local role name in the local language","example":"Directeur"},"englishTranslation":{"type":"string","description":"The role name in English","example":"Director"},"iso5009Code":{"type":"string","description":"The ISO 5009 role code","example":"GIDXNF"},"semaphoreStandard":{"example":"Director","description":"The standardized role of the individual.","deprecated":true,"allOf":[{"$ref":"#/components/schemas/RoleEnum"}]},"standardized":{"example":"Director","description":"The standardized role of the individual.","allOf":[{"$ref":"#/components/schemas/RoleEnum"}]}},"required":["standardized"]},"PhysicalPersonBaseDTO":{"type":"object","properties":{"gender":{"type":"string","description":"Gender of the person","enum":["Male","Female","Other","PreferNotToSay"],"example":"Female"},"name":{"description":"Full name of the person","example":{"fullName":"John Doe"},"allOf":[{"$ref":"#/components/schemas/PersonNameDTO"}]},"birthDate":{"description":"Birth date of the person","example":{"day":15,"month":7,"year":1980},"allOf":[{"$ref":"#/components/schemas/BirthDateDTO"}]},"birthAddress":{"description":"Birth address of the person","example":{"country":"FR","city":"Paris","street":"1 Rue de Rivoli","postalCode":"75001"},"allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"nationality":{"type":"string","description":"Nationality ISO2 country code of the person","example":"US"},"residenceAddress":{"description":"Residence address of the person","allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"identifiers":{"type":"object","description":"Identifiers for the person, as a flat object keyed by identifier type (e.g., codice fiscale, national ID). Each value is the identifier string.","additionalProperties":{"type":"string"},"example":{"codiceFiscale":"RSSMRA80A01H501U"}}}},"SigningPowersDTO":{"type":"object","properties":{"localText":{"type":"string","description":"Original authority text as published by the source register for this appointment. Read this for limits and conditions even when representationMode is present."},"englishTranslation":{"type":"string","description":"English translation of the original authority text, when available."}},"required":["localText"]},"RepresentationModeDTO":{"type":"object","properties":{"mode":{"type":"string","description":"Whether this representative can act alone (sole) or must act jointly with others (joint)","enum":["sole","joint"],"example":"sole"},"particularity":{"description":"Original authority scope and restrictions stated by the register, with an optional English translation.","allOf":[{"$ref":"#/components/schemas/SigningPowersDTO"}]},"minimumSignatories":{"type":"number","description":"Minimum number of signatories required for joint representation (e.g. 2 for \"Kollektivzeichnung zu zweien\")","example":2},"namedCoSigners":{"description":"Named co-signers this person must act with for joint representation","example":["Kázsmér János"],"type":"array","items":{"type":"string"}}},"required":["mode"]},"SigningRuleAmountLimitDTO":{"type":"object","properties":{"amount":{"type":"number","description":"Threshold amount","example":500000},"currency":{"type":"string","description":"ISO 4217 currency of the threshold","example":"EUR"},"comparator":{"type":"string","description":"up_to: the rule applies for amounts up to `amount`; above: from `amount` upwards","enum":["up_to","above"],"example":"up_to"}},"required":["amount","currency","comparator"]},"SigningRuleCoSignersDTO":{"type":"object","properties":{"minimum":{"type":"number","description":"Minimum number of signatories, including this representative","example":2},"named":{"description":"Named persons who must co-sign","type":"array","items":{"type":"string"}},"roles":{"description":"Roles or bodies that must co-sign (e.g. \"another director\", \"the chief financial officer\")","type":"array","items":{"type":"string"}}}},"SigningRuleDTO":{"type":"object","properties":{"scope":{"type":"string","description":"English summary of the category of acts this rule covers","example":"Contracts for the purchase, sale and lease of goods and services in the ordinary course of business"},"mode":{"type":"string","description":"Whether this representative signs alone or jointly for the acts in scope","enum":["sole","joint"],"example":"sole"},"amountLimit":{"$ref":"#/components/schemas/SigningRuleAmountLimitDTO"},"coSigners":{"$ref":"#/components/schemas/SigningRuleCoSignersDTO"},"sourceExcerpt":{"type":"string","description":"Verbatim slice of signingPowers.localText this rule was read from, for review"}},"required":["scope","mode","sourceExcerpt"]},"SigningAuthorityDTO":{"type":"object","properties":{"verdict":{"type":"string","description":"Overall reading of signingPowers.localText for this appointment. sole: binds the company alone for every listed power; sole_within_limits: alone for some powers or below stated thresholds, jointly or not at all beyond them; joint: every power needs another signatory; unclear: the text does not let a reader decide.","enum":["sole","sole_within_limits","joint","unclear"],"example":"sole_within_limits"},"rules":{"description":"One entry per distinct power or condition found in the text, in source order","type":"array","items":{"$ref":"#/components/schemas/SigningRuleDTO"}},"confidence":{"type":"string","description":"How confidently the text supports the verdict and rules","enum":["high","medium","low"],"example":"high"},"derivedFrom":{"type":"string","description":"Always \"ai\": this analysis is model-derived from the register text and is not itself a register statement. signingPowers.localText remains the authoritative record.","enum":["ai"],"example":"ai"}},"required":["verdict","rules","confidence","derivedFrom"]},"CorporateBody":{"type":"string","enum":["board","supervisoryBoard","management","audit"],"description":"The constituted body of the company this person holds a seat on. Absent when they sit on none (an authorized signatory holds a power of attorney, not a seat). Because a board member without signing authority is published under `otherKeyPersons` rather than here, filter this field across BOTH arrays to list a full board: `[...legalRepresentatives, ...otherKeyPersons].filter(p => p.corporateBody === 'board')`."},"LegalRepresentativeDTO":{"type":"object","properties":{"entityId":{"type":"string","description":"Identifies the same person or company within a request, including across legal representatives, shareholders, and UBOs. It can repeat within legalRepresentatives when an entity holds multiple roles. Group by entityId to identify the entity while preserving each role and its appointment dates. Neither entityId alone nor entityId combined with role.standardized uniquely identifies a role entry: different local roles can share the same standardized category. This is not a permanent identifier across separate requests.","example":"person_001"},"role":{"description":"The role of the legal representative","allOf":[{"$ref":"#/components/schemas/RoleDTO"}]},"startDate":{"type":"string","description":"The start date of the legal representative's role","example":"2022-01-01"},"endDate":{"type":"string","description":"The end date of the legal representative's role (if applicable)","example":"2023-12-31"},"type":{"type":"string","description":"The type of the legal representative (individual or company)","enum":["individual","company"],"example":"individual"},"individual":{"description":"Details of the individual legal representative","allOf":[{"$ref":"#/components/schemas/PhysicalPersonBaseDTO"}]},"company":{"description":"Details of the company legal representative","allOf":[{"$ref":"#/components/schemas/CompanyDTO"}]},"representedBy":{"description":"When type is COMPANY: the physical person who represents/acts on behalf of the company (e.g., \"représentant permanent\" in French)","allOf":[{"$ref":"#/components/schemas/PhysicalPersonBaseDTO"}]},"representationMode":{"description":"Sole or joint signing mode when the register wording supports one mode for the appointment. Absent when authority is conditional, mixed, or not classified; absence does not mean this person lacks authority.","allOf":[{"$ref":"#/components/schemas/RepresentationModeDTO"}]},"signingPowers":{"description":"Authority text published for this appointment. May contain transaction limits, exceptions or alternative signing arrangements. An absent representationMode does not imply absence of authority; consult this text when no single sole/joint mode applies.","allOf":[{"$ref":"#/components/schemas/SigningPowersDTO"}]},"signingAuthority":{"description":"Model-derived structured reading of signingPowers.localText: a verdict on whether this representative can bind the company alone, and one rule per power with its scope, mode, amount limit and co-signer requirement. Present when the register publishes free-text powers that the deterministic parsers cannot reduce to one representationMode; where the text is read by the model (e.g. Belgian agentic enrichment), a representationMode may sit alongside it, set only when the reading is confident and yields one mode for general representation. signingPowers.localText stays the authoritative record; every rule cites the excerpt it was read from.","allOf":[{"$ref":"#/components/schemas/SigningAuthorityDTO"}]},"corporateBody":{"description":"The constituted body of the company this person holds a seat on. Absent when they sit on none (an authorized signatory holds a power of attorney, not a seat). Because a board member without signing authority is published under `otherKeyPersons` rather than here, filter this field across BOTH arrays to list a full board: `[...legalRepresentatives, ...otherKeyPersons].filter(p => p.corporateBody === 'board')`.","example":"board","allOf":[{"$ref":"#/components/schemas/CorporateBody"}]}},"required":["type"]},"ShareholderDTO":{"type":"object","properties":{"entityId":{"type":"string","description":"Unique identifier to track the same person or company across different roles (legal representatives, shareholders, UBOs, etc.). Since data is retrieved from multiple registries, the same entity may appear with slightly different names or details. This ID allows you to identify that \"John Smith\" as a legal representative is the same person as \"J. Smith\" listed as a shareholder.","example":"person_001"},"type":{"type":"string","description":"The type of the shareholder. `unknown`: the source names a holder without its legal nature. `aggregate`: shares whose holders the source does not name (for example the undisclosed members of a listed company, or a share class held by unnamed holders); it is not a person or a company, and `name` carries the source label.","enum":["individual","company","unknown","aggregate"],"example":"individual"},"name":{"type":"string","description":"Source label when type is `unknown` (the disclosed holder name) or `aggregate` (the label of the unnamed pool, such as \"Undisclosed Shareholders\"). No person or company classification is inferred."},"individual":{"description":"Details of the individual shareholder","allOf":[{"$ref":"#/components/schemas/PhysicalPersonBaseDTO"}]},"company":{"description":"Details of the company shareholder","allOf":[{"$ref":"#/components/schemas/CompanyDTO"}]},"sharePercentage":{"type":"number","description":"The percentage of shares owned by the shareholder","example":25.5},"numberOfShares":{"type":"number","description":"The absolute number of shares owned by the shareholder","example":1000},"nominalCapitalHeld":{"description":"Total nominal (stated) capital value held by this shareholder. This is the face value or par value of all shares owned, calculated as numberOfShares × parValuePerShare. For example, if a shareholder owns 1000 shares with a par value of €10 each, nominalCapitalHeld would be €10,000. This value represents the legal capital contribution recorded in company documents, not the market value or actual amount paid.","readOnly":true,"allOf":[{"$ref":"#/components/schemas/MonetaryAmountDTO"}]},"paidInAmount":{"description":"Total actual amount paid by the shareholder for their shares, including any share premium over the nominal/par value. This represents the real money invested. For example, if shares with €10,000 nominal value were purchased for €15,000, the paidInAmount would be €15,000. In Italy this corresponds to \"valore versato\", in Germany to \"eingezahltes Kapital\". This field captures the actual capital contribution to the company.","allOf":[{"$ref":"#/components/schemas/MonetaryAmountDTO"}]}},"required":["type"]},"SharePercentageRangeDTO":{"type":"object","properties":{"lower":{"type":"number","description":"Lower percentage bound (0–100).","minimum":0,"maximum":100},"upper":{"type":"number","description":"Upper percentage bound (0–100).","minimum":0,"maximum":100},"lowerInclusive":{"type":"boolean","description":"Whether the lower bound is included. Omitted if unspecified by the source."},"upperInclusive":{"type":"boolean","description":"Whether the upper bound is included. Omitted if unspecified by the source."}},"required":["lower","upper"]},"SubsidiaryDTO":{"type":"object","properties":{"entityId":{"type":"string","description":"Unique identifier to track the same company across different roles (subsidiaries, shareholders, etc.). Since data is retrieved from multiple registries, the same entity may appear with slightly different names or details. This ID lets you correlate a subsidiary with its appearance elsewhere in the response.","example":"company_001"},"company":{"description":"The company in which the queried company holds equity. Always present — a subsidiary is, by definition, a company.","allOf":[{"$ref":"#/components/schemas/CompanyDTO"}]},"sharePercentage":{"type":"number","description":"Exact direct equity stake in the subsidiary (0–100). Omitted when only an interval is disclosed; see sharePercentageRange.","example":75},"sharePercentageRange":{"description":"Disclosed direct equity interval. Mutually exclusive with sharePercentage. Omitted when no percentage information is available.","example":{"lower":25,"upper":50,"lowerInclusive":false,"upperInclusive":true},"allOf":[{"$ref":"#/components/schemas/SharePercentageRangeDTO"}]},"totalSharePercentage":{"type":"number","description":"Total equity stake including ownership held indirectly through other entities in the chain. Populated only when the source can compute consolidated ownership (e.g. financial statements). Sources that only carry direct stakes leave this undefined.","example":80},"votingRightsPercentage":{"type":"number","description":"Voting-rights percentage in the subsidiary. May differ from sharePercentage when non-voting shares exist (preferred shares, dual-class structures). Populated when the source distinguishes equity from voting power.","example":75},"numberOfShares":{"type":"number","description":"Absolute number of shares held in the subsidiary.","example":1000},"nominalCapitalHeld":{"description":"Total nominal (stated) capital value of the equity held in the subsidiary. Face value × number of shares. Equivalent to \"valore nominale × n-azioni\" in Italian InfoCamere data.","allOf":[{"$ref":"#/components/schemas/MonetaryAmountDTO"}]},"paidInAmount":{"description":"Total amount actually paid for the equity held, including any premium over nominal value. Italian \"valore versato\".","allOf":[{"$ref":"#/components/schemas/MonetaryAmountDTO"}]},"acquisitionDate":{"type":"string","description":"Date the equity stake was acquired (ISO 8601: YYYY-MM-DD). Sourced from register filings — for Italian InfoCamere this is the earliest dt-evento on the participation record.","example":"2020-06-15"},"endDate":{"type":"string","description":"Date the equity stake ended (sale, dissolution of the subsidiary, etc.). When present, the participation is historical rather than current. ISO 8601: YYYY-MM-DD.","example":"2024-03-15"}},"required":["company"]},"EstablishmentDTO":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the establishment","example":"EST-001"},"name":{"type":"string","description":"The name of the establishment","example":"Main Office"},"creationDate":{"type":"string","description":"The creation date of the establishment","example":"2020-01-15"},"endDate":{"type":"string","description":"The closing date of the establishment (if applicable)","example":"2023-12-31"},"active":{"type":"boolean","description":"Whether the establishment is currently active","example":true},"address":{"description":"The address of the establishment","allOf":[{"$ref":"#/components/schemas/AddressDTO"}]},"activities":{"type":"object","description":"A dictionary of activity classifications for this establishment. In multi-establishment countries (e.g. France, Belgium) each site can carry its own activity codes, which may differ from the company-level activity.","example":{"NACE":[{"code":"62.01","description":"Computer programming activities"}],"ISIC":[{"code":"J620","description":"Computer programming, consultancy and related activities"}]},"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}}}},"required":["name"]},"OtherKeyPersonRoleEnum":{"type":"string","enum":["Chairman of the Board","Vice Chairman of the Board","Board Member","Non-Executive Director","Independent Director","Advisory Board Member","Board Observer","Auditor","Compliance Officer","Data Protection Officer","Money Laundering Reporting Officer","Secretary","Supervisor","Supervisory Board Member","C-Level Executive","Vice President","Registered Agent","Other"],"description":"The standardized role of the individual."},"OtherKeyPersonRoleDTO":{"type":"object","properties":{"localName":{"type":"string","description":"The local role name in the local language","example":"Commissaire aux comptes"},"englishTranslation":{"type":"string","description":"The role name in English","example":"Auditor"},"semaphoreStandard":{"example":"Board Member","description":"The standardized role of the individual.","deprecated":true,"allOf":[{"$ref":"#/components/schemas/OtherKeyPersonRoleEnum"}]},"standardized":{"example":"Board Member","description":"The standardized role of the individual.","allOf":[{"$ref":"#/components/schemas/OtherKeyPersonRoleEnum"}]}},"required":["standardized"]},"OtherKeyPersonDTO":{"type":"object","properties":{"entityId":{"type":"string","description":"Unique identifier to track the same person or company across different roles (legal representatives, shareholders, UBOs, etc.). Since data is retrieved from multiple registries, the same entity may appear with slightly different names or details. This ID allows you to identify that \"John Smith\" as a legal representative is the same person as \"J. Smith\" listed as a shareholder.","example":"person_001"},"role":{"description":"The role of the other key person","allOf":[{"$ref":"#/components/schemas/OtherKeyPersonRoleDTO"}]},"startDate":{"type":"string","description":"The start date of the role","example":"2022-01-01"},"endDate":{"type":"string","description":"The end date of the role (if applicable)","example":"2023-12-31"},"type":{"type":"string","enum":["individual","company"],"description":"The type of the other key person (individual or company)","example":"individual"},"individual":{"description":"Details if the other key person is an individual","allOf":[{"$ref":"#/components/schemas/PhysicalPersonBaseDTO"}]},"company":{"description":"Details if the other key person is a company","allOf":[{"$ref":"#/components/schemas/CompanyDTO"}]},"corporateBody":{"description":"The constituted body of the company this person holds a seat on. Absent when they sit on none. A board member with no signing authority is published here rather than under `legalRepresentatives`, so filter this field across BOTH arrays to list a full board: `[...legalRepresentatives, ...otherKeyPersons].filter(p => p.corporateBody === 'board')`.","example":"board","allOf":[{"$ref":"#/components/schemas/CorporateBody"}]}},"required":["type"]},"DataSourceDocumentDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name of the supporting document","example":"Statuts constitutifs"},"date":{"type":"string","description":"Date of the document","example":"2020-03-15"},"reason":{"type":"string","description":"Brief explanation of why this document is pertinent for the analysis","example":"Most recent confirmation statement showing 100% ownership by KCA Deutag International 3 Limited"},"register":{"type":"string","description":"Machine-readable code of the register this document was collected from. Same vocabulary as DataSourceDTO.register and the source.register carried by every document in availableDocuments/documents. Omitted when the register is unknown.","example":"companies_house"}},"required":["name"]},"DataSourceDTO":{"type":"object","properties":{"type":{"type":"string","description":"How the data was obtained: live_from_registry (fresh API call), cached_from_registry (database copy), inferred (simple derivation from registry data), ai_analysis (complex AI analysis from documents), private_source (paid data)","enum":["live_from_registry","cached_from_registry","inferred","ai_analysis","private_source"],"example":"live_from_registry"},"register":{"type":"string","description":"Machine-readable register code. Omitted for inferred and ai_analysis types.","example":"inpi"},"documents":{"description":"Supporting documents (for ai_analysis type)","type":"array","items":{"$ref":"#/components/schemas/DataSourceDocumentDTO"}},"analysis":{"type":"string","description":"AI reasoning summary explaining how the data was derived (for ai_analysis type)","example":"Inferred from 2021 confirmation statement showing 100% ownership by KCA Deutag International 3 Limited"}},"required":["type"]},"AvailableDocumentDTO":{"type":"object","properties":{"format":{"type":"string","description":"Document format (ISO format)","example":"PDF"},"description":{"type":"string","description":"Document description","example":"Uncertified trade register extract, provided by the French INPI"},"estimatedDeliverySeconds":{"type":"number","description":"Estimated delivery time in seconds","example":0},"name":{"type":"string","description":"Document name in the original language","example":"Certificat INPI"},"id":{"type":"string","description":"Document ID for this specific company document. Pass this ID to the \"documents\" array in a follow-up request when you want to download it.","example":"1c932de4-4610-5506-b48d-4e62529d58e8"},"date":{"format":"date-time","type":"string","description":"Document date","example":"2024-06-30T23:59:59Z"},"type":{"type":"string","description":"Document type","enum":["financial_statement","uncertified_trade_register_extract","certified_trade_register_extract","ubo_extract","status","trade_register_history","official_publication","annual_return","certificate_of_good_standing","unknown","other"],"example":"uncertified_trade_register_extract"},"subType":{"type":"string","description":"Stable, closed-vocabulary per-country classifier of the document kind. See DocumentWithUrlDto.subType for details.","example":"pj_02"},"price":{"type":"number","description":"Document price, in credits","example":3},"source":{"description":"Source register the document is issued from — same shape as dataSources entries (type + machine-readable register code).","allOf":[{"$ref":"#/components/schemas/DataSourceDTO"}]}},"required":["name","id","type"]},"DocumentDTO":{"type":"object","properties":{"id":{"type":"string","description":"Document ID returned by the \"availableDocuments\" data point for this specific company document.","example":"1c932de4-4610-5506-b48d-4e62529d58e8"},"url":{"type":"string","description":"Temporary document download URL with a 15-minute lifetime. If the URL expires, you can request the same document again within 24 hours without being charged.","example":"https://example.com/download/document123"},"blobName":{"type":"string","description":"Blob name","example":"document123.pdf"}},"required":["id","url"]},"CompanyActivityItemDTO":{"type":"object","properties":{"code":{"type":"string","description":"The activity code","example":"62.01"},"description":{"type":"string","description":"The description of the activity","example":"Computer programming activities"},"isAIInferred":{"type":"boolean","description":"Indicates whether the activity code comes from an official source or has been inferred by AI","example":true},"isMainActivity":{"type":"boolean","description":"Indicates that this code is the company's main (primary) activity as declared by the register. Absent when the register does not distinguish a main activity — absence means unknown, not secondary.","example":true}},"required":["code"]},"CompanyActivitiesDTO":{"type":"object","properties":{"ISIC":{"description":"The ISIC activity codes of the company, as deep as possible (ISIC Rev. 5)","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE":{"description":"The NACE activity codes of the company, as deep as possible (NACE Rev. 2.1)","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_REV2":{"description":"The register's own NACE class, at NACE Rev. 2 — including France, where NAF rev. 2 is the French implementation of NACE Rev. 2 and an APE code's first four digits are the Rev. 2 class. Present whenever the register gave us an APE code. Read this when you need the 4-digit class the register recorded: NACE Rev. 2.1 deleted a number of Rev. 2 classes, so the standardized NACE key can legitimately answer at group level (86.90F -> NACE 86.9, NACE_REV2 86.90). Do not treat these codes as Rev. 2.1.","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAF_2025":{"description":"France only. The company's NAF 2025 code as assigned by INSEE (e.g. 86.93Y), the French implementation of NACE Rev. 2.1: its first four digits are the NACE Rev. 2.1 class, the letter a French sub-class. NAF 2025 becomes the reference nomenclature for APE codes on 2027-01-01; until then INSEE publishes it provisionally, and this key is present whenever INSEE has assigned one (essentially every active company). Labels are INSEE's official French wording.","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_REV1":{"description":"NACE_REV1 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_REV11":{"description":"NACE_REV11 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_BEL":{"description":"NACE_BEL activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_BEL_2003":{"description":"NACE_BEL_2003 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_BEL_2008":{"description":"NACE_BEL_2008 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_BEL_2025":{"description":"NACE_BEL_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"WZ_2008":{"description":"WZ_2008 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"WZ_2025":{"description":"WZ_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"DB25":{"description":"DB25 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CNAE_2009":{"description":"CNAE_2009 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CNAE_BR":{"description":"CNAE_BR activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CIIU_CO":{"description":"CIIU_CO activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CLAE_AR":{"description":"CLAE_AR activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CIIU_CL":{"description":"CIIU_CL activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CIIU_EC":{"description":"CIIU_EC activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TOL":{"description":"TOL activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TOL_1995":{"description":"TOL_1995 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TOL_2002":{"description":"TOL_2002 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TOL_2008":{"description":"TOL_2008 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TOL_2025":{"description":"TOL_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAF":{"description":"NAF activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAF_1993":{"description":"NAF_1993 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAF_REV1":{"description":"NAF_REV1 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAF_REV2":{"description":"NAF_REV2 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAP":{"description":"NAP activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"RNA":{"description":"RNA activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"ALSACE_MOSELLE":{"description":"ALSACE_MOSELLE activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"SIC":{"description":"SIC activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"SIC_2007":{"description":"SIC_2007 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"KAD_2025":{"description":"KAD_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NKD":{"description":"NKD activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NKD_1994":{"description":"NKD_1994 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NKD_2007":{"description":"NKD_2007 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NKD_2025":{"description":"NKD_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TEAOR":{"description":"TEAOR activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TEAOR_2008":{"description":"TEAOR_2008 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TEAOR_2025":{"description":"TEAOR_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"ATECO_2007":{"description":"ATECO_2007 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"ATECO_2025":{"description":"ATECO_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAEM_REV11":{"description":"CAEM_REV11 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAEM_REV2":{"description":"CAEM_REV2 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"SBI":{"description":"SBI activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAE_REV3":{"description":"CAE_REV3 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAE_QC":{"description":"CAE_QC activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"OKVED_REV2":{"description":"OKVED_REV2 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"SNI_2025":{"description":"SNI_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"KVED_2010":{"description":"KVED_2010 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NAICS":{"description":"NAICS activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"PKD":{"description":"PKD activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAEN":{"description":"CAEN activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAEN_REV2":{"description":"CAEN_REV2 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"CAEN_REV3":{"description":"CAEN_REV3 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NKID":{"description":"NKID activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"EMTAK":{"description":"EMTAK activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"EMTAK_2008":{"description":"EMTAK_2008 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"EMTAK_2025":{"description":"EMTAK_2025 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_EE":{"description":"NACE_EE activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NACE_SK":{"description":"NACE_SK activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"SKD":{"description":"SKD activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"ISAT_2008":{"description":"ISAT_2008 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"KD_BIH_2010":{"description":"KD_BIH_2010 activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"NOGA":{"description":"NOGA activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"SSIC":{"description":"SSIC activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"GG_ACTIVITY":{"description":"GG_ACTIVITY activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}},"TW_BUSINESS_ITEM":{"description":"TW_BUSINESS_ITEM activity codes","type":"array","items":{"$ref":"#/components/schemas/CompanyActivityItemDTO"}}},"additionalProperties":false},"DocumentWithUrlDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Document name in the local language of the country where it was issued"},"description":{"type":"string","description":"Document description in English"},"subType":{"type":"string","description":"Stable, closed-vocabulary per-country classifier of the document kind. Present whenever the same response field can carry documents of multiple kinds (every array-valued field, plus singletons whose underlying document varies by entity type — e.g. AT tradeRegisterExtract). Use it as the stable join key against the country's documents catalog rather than matching on `name`.","example":"pj_02"},"format":{"type":"string"},"estimatedDeliverySeconds":{"type":"number"},"url":{"type":"string"},"pdfUrl":{"type":"string","description":"URL to converted PDF version (when original document is XML)"},"blobName":{"type":"string"},"price":{"type":"number","description":"Fixed price in cents"},"priceMarkup":{"type":"number","description":"Price markup percentage"},"date":{"type":"string"},"source":{"description":"Source register the document is issued from — same shape as dataSources entries (type + machine-readable register code).","allOf":[{"$ref":"#/components/schemas/DataSourceDTO"}]}},"required":["id","name"]},"PeriodDateDTO":{"type":"object","properties":{"year":{"type":"number"},"month":{"type":"number"},"day":{"type":"number"}}},"PeriodDTO":{"type":"object","properties":{"startDate":{"$ref":"#/components/schemas/PeriodDateDTO"},"endDate":{"$ref":"#/components/schemas/PeriodDateDTO"}}},"FinancialRatiosDTO":{"type":"object","properties":{"currentRatio":{"type":"number"},"quickRatio":{"type":"number"},"debtToEquity":{"type":"number"},"netProfitMargin":{"type":"number"},"returnOnEquity":{"type":"number"},"revenueGrowth":{"type":"number"}}},"FinancialInsightDTO":{"type":"object","properties":{"category":{"type":"string","enum":["liquidity","profitability","solvency","efficiency","growth","risk"]},"title":{"type":"string"},"description":{"type":"string"},"riskLevel":{"type":"string","enum":["low","medium","high","critical"]},"metricValue":{"type":"string"},"recommendation":{"type":"string"}},"required":["category","title","description","riskLevel"]},"FinancialTrendsDTO":{"type":"object","properties":{"revenueDirection":{"type":"string","enum":["increasing","stable","decreasing","unknown"]},"profitabilityDirection":{"type":"string","enum":["improving","stable","declining","unknown"]},"debtDirection":{"type":"string","enum":["decreasing","stable","increasing","unknown"]}},"required":["revenueDirection","profitabilityDirection","debtDirection"]},"FinancialAnalysisDTO":{"type":"object","properties":{"summary":{"type":"string","description":"Executive summary (2-3 sentences)"},"narrativeAnalysis":{"type":"string","description":"Detailed multi-paragraph narrative analysis"},"healthScore":{"type":"number","description":"Overall health score (1-10)"},"overallRisk":{"type":"string","enum":["low","medium","high","critical"]},"ratios":{"$ref":"#/components/schemas/FinancialRatiosDTO"},"insights":{"type":"array","items":{"$ref":"#/components/schemas/FinancialInsightDTO"}},"strengths":{"type":"array","items":{"type":"string"}},"concerns":{"type":"array","items":{"type":"string"}},"trends":{"$ref":"#/components/schemas/FinancialTrendsDTO"}},"required":["summary","narrativeAnalysis","healthScore","overallRisk","ratios","insights","strengths","concerns","trends"]},"ExtractedFinancialDataDTO":{"type":"object","properties":{"fiscalYear":{"type":"object","description":"Fiscal year period covered by the financial statement"},"approvalDate":{"type":"string"},"currency":{"type":"string"},"accountingStandard":{"type":"string","enum":["IFRS","French GAAP","US GAAP","Swiss GAAP","Lux GAAP","Other"]},"statementType":{"type":"string","enum":["consolidated","simplified"]},"analysis":{"description":"AI-generated financial analysis and insights","allOf":[{"$ref":"#/components/schemas/FinancialAnalysisDTO"}]},"incomeStatement":{"type":"object"},"balanceSheet":{"type":"object"}}},"FinancialStatementDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Document name in the local language of the country where it was issued"},"description":{"type":"string","description":"Document description in English"},"subType":{"type":"string","description":"Stable, closed-vocabulary per-country classifier of the document kind. Present whenever the same response field can carry documents of multiple kinds (every array-valued field, plus singletons whose underlying document varies by entity type — e.g. AT tradeRegisterExtract). Use it as the stable join key against the country's documents catalog rather than matching on `name`.","example":"pj_02"},"format":{"type":"string"},"estimatedDeliverySeconds":{"type":"number"},"url":{"type":"string"},"pdfUrl":{"type":"string","description":"URL to converted PDF version (when original document is XML)"},"blobName":{"type":"string"},"price":{"type":"number","description":"Fixed price in cents"},"priceMarkup":{"type":"number","description":"Price markup percentage"},"date":{"type":"string"},"source":{"description":"Source register the document is issued from — same shape as dataSources entries (type + machine-readable register code).","allOf":[{"$ref":"#/components/schemas/DataSourceDTO"}]},"period":{"$ref":"#/components/schemas/PeriodDTO"},"extractedFinancialData":{"description":"Extracted financial data from the document (only available after document is downloaded and parsed)","allOf":[{"$ref":"#/components/schemas/ExtractedFinancialDataDTO"}]}},"required":["id","name"]},"ArticleOfAssociationDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Document name in the local language of the country where it was issued"},"description":{"type":"string","description":"Document description in English"},"subType":{"type":"string","description":"Stable, closed-vocabulary per-country classifier of the document kind. Present whenever the same response field can carry documents of multiple kinds (every array-valued field, plus singletons whose underlying document varies by entity type — e.g. AT tradeRegisterExtract). Use it as the stable join key against the country's documents catalog rather than matching on `name`.","example":"pj_02"},"format":{"type":"string"},"estimatedDeliverySeconds":{"type":"number"},"url":{"type":"string"},"pdfUrl":{"type":"string","description":"URL to converted PDF version (when original document is XML)"},"blobName":{"type":"string"},"price":{"type":"number","description":"Fixed price in cents"},"priceMarkup":{"type":"number","description":"Price markup percentage"},"date":{"type":"string"},"source":{"description":"Source register the document is issued from — same shape as dataSources entries (type + machine-readable register code).","allOf":[{"$ref":"#/components/schemas/DataSourceDTO"}]}},"required":["id","name"]},"DocumentsDTO":{"type":"object","properties":{"tradeRegisterExtract":{"$ref":"#/components/schemas/DocumentWithUrlDto"},"certifiedTradeRegisterExtract":{"$ref":"#/components/schemas/DocumentWithUrlDto"},"tradeRegisterHistory":{"description":"Historical trade register extract — full ledger of changes since incorporation. Available where the register exposes a separate historical document (e.g. NL KVK historie, IT Visura Storica).","allOf":[{"$ref":"#/components/schemas/DocumentWithUrlDto"}]},"financialStatements":{"type":"array","items":{"$ref":"#/components/schemas/FinancialStatementDTO"}},"articlesOfAssociation":{"type":"array","items":{"$ref":"#/components/schemas/ArticleOfAssociationDTO"}},"ultimateBeneficialOwnersCertificate":{"$ref":"#/components/schemas/DocumentWithUrlDto"},"officialPublications":{"type":"array","items":{"$ref":"#/components/schemas/DocumentWithUrlDto"}},"annualReturns":{"type":"array","items":{"$ref":"#/components/schemas/DocumentWithUrlDto"}},"certificateOfGoodStanding":{"$ref":"#/components/schemas/DocumentWithUrlDto"},"otherDocuments":{"type":"array","items":{"$ref":"#/components/schemas/DocumentWithUrlDto"}},"lastFiscalYearFinancialStatement":{"$ref":"#/components/schemas/DocumentWithUrlDto"}}},"GraphIndividualDTO":{"type":"object","properties":{"name":{"type":"object","description":"Full name of the person"},"birthDate":{"type":"object","description":"Date of birth, if available"},"nationality":{"type":"string","description":"Nationality ISO2 country code","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NB","CA-NL","CA-PE","CA-YT","CA-NT","CA-NU","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","DE-SCHUFA","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KP","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-NJ","US-NM","US-NY","US-OH","US-TX","US-DE","US-WA","US-AL","US-TN","US-WY","US-GA","US-MN","US-MO","US-NV","US-PA","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","US-NH","US-PR","TEST"]}},"required":["name"]},"GraphCompanyDTO":{"type":"object","properties":{"id":{"type":"string","description":"Company registration ID/number (optional for individuals)"},"legalName":{"type":"string","description":"Legal name of the company"},"countryCode":{"type":"string","description":"Country of registration","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NB","CA-NL","CA-PE","CA-YT","CA-NT","CA-NU","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","DE-SCHUFA","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KP","XK","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-NJ","US-NM","US-NY","US-OH","US-TX","US-DE","US-WA","US-AL","US-TN","US-WY","US-GA","US-MN","US-MO","US-NV","US-PA","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","US-NH","US-PR","TEST"]}},"required":["legalName","countryCode"]},"GraphNodeFlagsDTO":{"type":"object","properties":{"isRoot":{"type":"boolean","description":"True if this is the root/target company being analyzed"},"isUbo":{"type":"boolean","description":"True if this individual qualifies as a UBO through at least 25% ownership or ownership-backed control"},"isUboProxy":{"type":"boolean","description":"True if this company is the ultimate controlling entity of the target company (companies only)"},"uboCalculationMethod":{"type":"array","description":"Methods that qualified this individual as UBO (only when isUbo is true): accumulation sums multiplied ownership paths; domination identifies ownership-backed control, including mixed ownership and control chains. Non-ownership control rights are not assessed.","items":{"type":"string","enum":["accumulation","domination"]}},"status":{"type":"string","description":"Status of the node during graph building. `budget_truncated` marks a frontier company that was not fetched because the request ran out of credits; clients can submit a continuation request to expand it. `coverage_unavailable` marks a company in a country where we do not have shareholder data, so the ownership branch cannot be expanded further (no continuation can resolve it).","enum":["pending","found","not_found","error","search_resolved","placeholder","budget_truncated","coverage_unavailable"]}}},"GraphNodeContinuationDTO":{"type":"object","properties":{"reason":{"type":"string","description":"Why the BFS stopped at this node. `budget` = ran out of credits.","enum":["budget"]},"estimatedCost":{"type":"number","description":"Estimated cost in credit cents to fetch this company during a continuation. Dedup-aware: already-paid companies show ~0."},"accumulatedOwnership":{"type":"number","description":"Product of edge percentages from the root to this node (0–1). Undefined if any upstream hop lacked a percentage."},"depth":{"type":"number","description":"Depth of this node in the graph (root = 0)."}},"required":["reason","estimatedCost","depth"]},"GraphNodeDTO":{"type":"object","properties":{"nodeId":{"type":"string","description":"A unique identifier for the node in the graph (for graph traversal)"},"type":{"type":"string","description":"Whether this is an individual, a company, a holder whose legal nature is unknown, or an aggregate of shares whose holders the source does not name","enum":["individual","company","unknown","aggregate"]},"name":{"type":"string","description":"Source label when the holder type is unknown or aggregate"},"individual":{"description":"Individual person data (only populated when type is individual)","allOf":[{"$ref":"#/components/schemas/GraphIndividualDTO"}]},"company":{"description":"Company data (only populated when type is company)","allOf":[{"$ref":"#/components/schemas/GraphCompanyDTO"}]},"totalOwnershipPercentage":{"type":"number","description":"The total calculated ownership percentage of the root company (0-100)"},"flags":{"description":"Flags indicating special properties of this node","allOf":[{"$ref":"#/components/schemas/GraphNodeFlagsDTO"}]},"continuation":{"description":"Continuation metadata — present only on `budget_truncated` nodes.","allOf":[{"$ref":"#/components/schemas/GraphNodeContinuationDTO"}]}},"required":["nodeId","type"]},"GraphEdgeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the edge"},"fromId":{"type":"string","description":"ID of the company being owned"},"toId":{"type":"string","description":"ID of the entity that owns shares (shareholder)"},"percentage":{"type":"number","description":"Ownership percentage (0-100)"},"source":{"type":"string","description":"Source information about where this relationship was found"}},"required":["id","fromId","toId"]},"GraphMetadataDTO":{"type":"object","properties":{"stoppedReason":{"type":"string","description":"Reason why graph traversal stopped","enum":["completed","budget_exhausted","max_depth_reached","max_nodes_reached","timeout"]},"amountSpent":{"type":"number","description":"Total amount spent in credit cents during traversal"},"companiesFetched":{"type":"number","description":"Number of companies successfully fetched during traversal"},"companiesSkipped":{"type":"number","description":"Number of companies skipped (due to budget or limits)"},"interactive":{"type":"boolean","description":"True when the request was run in interactive mode. The traversal fetched only the entry node (root for an initial request, seed for a continuation) and emitted its direct company shareholders as `budget_truncated` chips for follow-up exploration. Continuation requests inherit this flag from the parent and cannot opt out."}},"required":["stoppedReason","amountSpent","companiesFetched","companiesSkipped"]},"EnhancedGraphResultDTO":{"type":"object","properties":{"nodes":{"description":"All entities in the ownership structure","type":"array","items":{"$ref":"#/components/schemas/GraphNodeDTO"}},"edges":{"description":"All ownership relationships","type":"array","items":{"$ref":"#/components/schemas/GraphEdgeDTO"}},"mermaidDiagram":{"type":"string","description":"Mermaid diagram representation"},"description":{"type":"string","description":"Human-readable description of the graph"},"metadata":{"description":"Metadata about the graph traversal process","allOf":[{"$ref":"#/components/schemas/GraphMetadataDTO"}]}},"required":["nodes","edges"]},"ShareholderNodeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the node"},"name":{"type":"string","description":"Name of the shareholder"},"type":{"type":"string","description":"Type of shareholder: individual, company, or unknown when the source does not disclose it","enum":["individual","company","unknown","aggregate"]},"countryCode":{"type":"string","description":"Country code","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW","DE-SCHUFA","TEST"]},"percentage":{"type":"number","description":"Ownership percentage"},"children":{"description":"Child nodes (recursive structure)","type":"array","items":{"$ref":"#/components/schemas/ShareholderNodeDTO"}},"error":{"type":"string","description":"Error message if node processing failed"}},"required":["id","name","type","children"]},"EntitySourcesDTO":{"type":"object","properties":{"entityId":{"type":"string","description":"Stable entity identifier matching the underlying entity (e.g. ShareholderDTO.entityId, GraphNodeDTO.nodeId for individuals). Lets consumers look up sources by entity rather than relying on positional alignment."},"fields":{"type":"object","description":"Per-field data sources, keyed by field name."},"overall":{"description":"Holistic source for this entity (e.g. an AI agent narrative explaining how this shareholder was traced). Distinct from per-field sources, which describe each individual datapoint.","allOf":[{"$ref":"#/components/schemas/DataSourceDTO"}]}}},"EntityListSourcesDTO":{"type":"object","properties":{"overall":{"description":"List-level source. Describes how the entire list was assembled (e.g. AI reconstruction summary covering all shareholders). The analysis field carries the prose; documents lists the supporting documents.","allOf":[{"$ref":"#/components/schemas/DataSourceDTO"}]},"limitations":{"description":"Structured list of gaps the AI agent flagged about building this list (e.g. unparseable documents, missing share-pledge agreements).","type":"array","items":{"type":"string"}},"items":{"description":"Per-entity sources, 1:1 by array index with the corresponding entity array (e.g. shareholders, ultimateBeneficialOwners).","type":"array","items":{"$ref":"#/components/schemas/EntitySourcesDTO"}}}},"GraphSourcesDTO":{"type":"object","properties":{"nodes":{"type":"object","description":"Per-node provenance, keyed by graph nodeId (graph.nodes[i].nodeId). Today only company nodes that had AI-reconstructed shareholders get an entry. Future per-node provenance types (UBO calculation reasoning, edge sources, etc.) become sibling fields inside each GraphNodeSourcesDTO."}}},"DataSourcesDTO":{"type":"object","properties":{"company":{"type":"object","description":"Per-field data sources for company profile fields. Keys are field names, values describe the source."},"shareholders":{"description":"Sources for the shareholders list. Carries list-level overall (e.g. AI reconstruction summary), limitations the agent flagged, and per-entity sources 1:1 by index with the shareholders array.","allOf":[{"$ref":"#/components/schemas/EntityListSourcesDTO"}]},"subsidiaries":{"description":"Sources for disclosed downstream company holdings and participations. Same shape as shareholders.","allOf":[{"$ref":"#/components/schemas/EntityListSourcesDTO"}]},"ultimateBeneficialOwners":{"description":"Sources for the ultimate beneficial owners list. Same shape as shareholders.","allOf":[{"$ref":"#/components/schemas/EntityListSourcesDTO"}]},"legalRepresentatives":{"description":"Sources for the legal representatives list. Same shape as shareholders.","allOf":[{"$ref":"#/components/schemas/EntityListSourcesDTO"}]},"establishments":{"description":"Sources for the establishments list. Same shape as shareholders.","allOf":[{"$ref":"#/components/schemas/EntityListSourcesDTO"}]},"otherKeyPersons":{"description":"Sources for the other key persons list. Same shape as shareholders.","allOf":[{"$ref":"#/components/schemas/EntityListSourcesDTO"}]},"graph":{"description":"Sources specific to the ownership graph (per-graph-node provenance). Each company node in the graph that had its shareholders AI-reconstructed carries its own EntityListSourcesDTO under nodes[<nodeId>].shareholders. Distinct from dataSources.shareholders, which is scoped to the result-level shareholders list (the root company only).","allOf":[{"$ref":"#/components/schemas/GraphSourcesDTO"}]}}},"DataPointStatusSucceeded":{"type":"object","properties":{"cost":{"type":"number","description":"The cost in credits for this data point or document","example":10},"costMarkup":{"type":"number","description":"The percentage markup when final cost is not yet known","example":20},"status":{"type":"string","description":"The data point completed successfully","enum":["succeeded"],"example":"succeeded"},"authoritative":{"type":"boolean","description":"Whether the data comes from an authoritative official registry source","example":true}},"required":["status"]},"DataPointStatusInProgress":{"type":"object","properties":{"cost":{"type":"number","description":"The cost in credits for this data point or document","example":10},"costMarkup":{"type":"number","description":"The percentage markup when final cost is not yet known","example":20},"status":{"type":"string","description":"The data point is being retrieved","enum":["in_progress"],"example":"in_progress"}},"required":["status"]},"DataPointStatusEnriching":{"type":"object","properties":{"cost":{"type":"number","description":"The cost in credits for this data point or document","example":10},"costMarkup":{"type":"number","description":"The percentage markup when final cost is not yet known","example":20},"status":{"type":"string","description":"The data point has been retrieved and is being enriched with additional details","enum":["enriching"],"example":"enriching"}},"required":["status"]},"PublicErrorCode":{"type":"string","enum":["resource_not_found","service_unavailable","source_unavailable","processing_failed","invalid_request","insufficient_funds","datapoint_not_supported","fast_source_unavailable","authoritative_source_unavailable","onboarding_timeout","no_data_available","no_document_available","manual_document_timeout","datapoint_not_applicable","account_configuration_required","budget_exceeded","request_cancelled","processing_interrupted","balance_negative","feature_not_enabled","quota_exceeded"],"description":"Every error code the API can return, in `dataStatus.*.error.code` and in the `error.code` of an HTTP error body. Each code has a fixed `retryable` flag and, when retryable, a recommended minimum `retryAfterSeconds` before resubmitting the same request.\nFor eligible temporary failures in verification mode, set `maxRetryDelaySeconds` (60 to 172800) on `POST /v2/company` to retry within the same request. Paid items retry only when no payment was started.\n\n- `service_unavailable` (retryable, retry after 300s, action `retry_later`): Topograph could not complete the lookup because of a temporary problem on its side.\n- `source_unavailable` (retryable, retry after 300s, action `retry_later`): The register behind this datapoint is down, rate limiting or timing out; `error.source` names it when known.\n- `processing_failed` (retryable, retry after 900s, action `retry_later`): The register answered, but Topograph could not process the response; the team is alerted automatically.\n- `request_cancelled` (retryable, retry after 0s, action `retry_now`): The request was cancelled before this item completed.\n- `processing_interrupted` (retryable, retry after 0s, action `retry_now`): Processing was interrupted before this item completed; no verdict was reached.\n- `resource_not_found` (not retryable, action `none`): No company exists in the register under this identifier.\n- `invalid_request` (not retryable, action `fix_request`): The request is malformed: an unknown datapoint, a badly formatted identifier or an invalid parameter.\n- `insufficient_funds` (not retryable, action `add_funds`): The wallet balance does not cover the price of this request.\n- `datapoint_not_supported` (not retryable, action `none`): Topograph does not return this datapoint for this country, in any mode.\n- `fast_source_unavailable` (not retryable, action `retry_without_onboarding_mode`): The datapoint exists for this country, but not in prefill mode.\n- `authoritative_source_unavailable` (not retryable, action `retry_with_onboarding_mode`): The datapoint exists for this country, but only from a non-authoritative source, which verification mode does not use.\n- `onboarding_timeout` (not retryable, action `retry_without_onboarding_mode`): The datapoint did not finish within the prefill-mode deadline.\n- `no_data_available` (not retryable, action `none`): The register answered, but holds no data for this company and datapoint.\n- `no_document_available` (not retryable, action `none`): The requested document is not available for this company; failed document orders are not charged.\n- `manual_document_timeout` (not retryable, action `contact_support`): A manually fulfilled document was not delivered within the expected timeframe.\n- `datapoint_not_applicable` (not retryable, action `none`): The datapoint does not exist for this entity's legal form, for example the shareholders of a sole trader.\n- `account_configuration_required` (not retryable, action `configure_account`): The data source needs account-specific credentials that are not configured on your account.\n- `budget_exceeded` (not retryable, action `raise_budget`): The quoted price exceeds the budget cap set on the request.\n- `balance_negative` (not retryable, action `add_funds`): The wallet balance is below zero; every request is refused until it is topped up.\n- `feature_not_enabled` (not retryable, action `contact_support`): The product is in beta and is not enabled on your account.\n- `quota_exceeded` (not retryable, action `contact_support`): The account's subscription allowance for the current period is used up."},"DataPointError":{"type":"object","properties":{"code":{"description":"Error code identifying the type of failure. Every code the platform can emit is listed in the `PublicErrorCode` schema, each with its `retryable` flag and recommended `retryAfterSeconds`. Treat it as an open vocabulary anyway: keep the raw string when you meet a value your client does not know, rather than dropping it.","example":"resource_not_found","allOf":[{"$ref":"#/components/schemas/PublicErrorCode"}]},"message":{"type":"string","description":"User-friendly error message explaining the failure","example":"The requested company was not found. Please verify the registration number and try again."},"details":{"type":"array","description":"Additional specific error details when applicable","items":{"type":"string"},"example":["Query must be at least 2 characters"]},"source":{"type":"string","description":"Source register that failed, when the failure is attributable to a specific external register","example":"handelsregister"},"retryable":{"type":"boolean","description":"Whether resubmitting the SAME request may succeed. Fixed per `code`: `true` only for `service_unavailable`, `source_unavailable`, `processing_failed`, `request_cancelled` and `processing_interrupted`. `false` means the same request returns the same answer; the `PublicErrorCode` schema says what to change instead (mode, request, account). A retry is a new `POST /v2/company`: polling `GET /v2/company/{requestId}` only reads the existing result.","example":true},"retryAfterSeconds":{"type":"number","description":"Recommended minimum wait, in seconds, before resubmitting the same request. Present exactly when `retryable` is true. `0` means resubmit right away. Guidance, not a guarantee: double the delay on each further failure, cap at one hour, and check status.topograph.co if failures persist.","example":300}},"required":["code","message"]},"DataPointStatusFailed":{"type":"object","properties":{"cost":{"type":"number","description":"The cost in credits for this data point or document","example":10},"costMarkup":{"type":"number","description":"The percentage markup when final cost is not yet known","example":20},"status":{"type":"string","description":"The data point retrieval failed","enum":["failed"],"example":"failed"},"error":{"description":"Error information for the failed data point","allOf":[{"$ref":"#/components/schemas/DataPointError"}]},"errors":{"type":"array","description":"Deprecated - use error.message instead","deprecated":true,"items":{"type":"string"}}},"required":["status","error"]},"DataStatus":{"type":"object","properties":{"dataPoints":{"type":"object","description":"Retrieval status of data points","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/DataPointStatusSucceeded"},{"$ref":"#/components/schemas/DataPointStatusInProgress"},{"$ref":"#/components/schemas/DataPointStatusEnriching"},{"$ref":"#/components/schemas/DataPointStatusFailed"}],"discriminator":{"propertyName":"status","mapping":{"succeeded":"#/components/schemas/DataPointStatusSucceeded","in_progress":"#/components/schemas/DataPointStatusInProgress","enriching":"#/components/schemas/DataPointStatusEnriching","failed":"#/components/schemas/DataPointStatusFailed"}}}},"documents":{"type":"object","description":"Retrieval status of documents","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/DataPointStatusSucceeded"},{"$ref":"#/components/schemas/DataPointStatusInProgress"},{"$ref":"#/components/schemas/DataPointStatusEnriching"},{"$ref":"#/components/schemas/DataPointStatusFailed"}],"discriminator":{"propertyName":"status","mapping":{"succeeded":"#/components/schemas/DataPointStatusSucceeded","in_progress":"#/components/schemas/DataPointStatusInProgress","enriching":"#/components/schemas/DataPointStatusEnriching","failed":"#/components/schemas/DataPointStatusFailed"}}}}},"required":["dataPoints","documents"]},"RequestMetadataDTO":{"type":"object","properties":{"companyId":{"type":"string","example":"932884117","description":"The requested company id."},"countryCode":{"type":"string","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"],"example":"FR","description":"The requested country code."},"requestId":{"type":"string","example":"request-12345","description":"The unique identifier for the request."},"version":{"type":"number","example":7,"description":"A monotonically increasing snapshot version for this request. The same requestId can produce multiple webhooks and responses as data points settle; a higher version is a newer snapshot. Use it to discard stale, out-of-order webhook deliveries: ignore any webhook whose version is lower than or equal to the highest you have already applied for this requestId. Scoped to a single requestId; do not compare across requests."},"dataPoints":{"type":"array","items":{"type":"string"}},"documents":{"type":"array","items":{"type":"string"}},"dataStatus":{"description":"Indicates the status of data points and documents associated with the company. It states if the data has been retrieved, if a job is in progress for asynchronous data, or if a job there was an error.","allOf":[{"$ref":"#/components/schemas/DataStatus"}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Arbitrary key-value string pairs provided at request creation time and echoed back in responses and webhooks."},"enrichmentReport":{"type":"string","description":"A human-readable summary of the agentic enrichment step, explaining what additional data was found or why enrichment could not provide more details. Only present when agenticEnrichment was requested."},"companyLegalName":{"type":"string","description":"The legal name of the company, if known from search results."},"workspace":{"type":"object","description":"The workspace associated with this request. Only present if the account uses workspaces."}},"required":["companyId","countryCode","requestId"]},"CompanyRelationshipDTO":{"type":"object","properties":{"relation":{"type":"string","enum":["mergedFrom","mergedInto","acquired","acquiredBy","demergedFrom","demergedTo","spunOffFrom","spunOffTo","assetTransferFrom","assetTransferTo","other"]},"company":{"description":"The counterparty company. Absent when the source names the relationship but not a resolvable company.","allOf":[{"$ref":"#/components/schemas/CompanyDTO"}]},"effectiveDate":{"type":"string","description":"Legal effective date if known (YYYY-MM-DD)"},"description":{"type":"string"}},"required":["relation"]},"GetCompanyResultDTO":{"type":"object","properties":{"request":{"description":"The request","allOf":[{"$ref":"#/components/schemas/RequestMetadataDTO"}]},"company":{"description":"The main profile information of the company, including, if available, details such as name, registration number, address, and other core data.","allOf":[{"$ref":"#/components/schemas/CompanyDTO"}]},"ultimateBeneficialOwners":{"description":"The persons of significant control of the company, including, if available, their name, nationality, and other relevant details.","type":"array","items":{"$ref":"#/components/schemas/UltimateBeneficialOwnerDTO"}},"legalRepresentatives":{"description":"The legal representatives of the company, which can be either individuals or companies.","type":"array","items":{"$ref":"#/components/schemas/LegalRepresentativeDTO"}},"shareholders":{"description":"The shareholders of the company, which can be either individuals or companies.","type":"array","items":{"$ref":"#/components/schemas/ShareholderDTO"}},"subsidiaries":{"description":"Companies in which the queried company holds equity (downstream participations). Includes any equity stake regardless of size — the relationship classification (controlled, associated, minority investment) is derived from sharePercentage by the consumer.","type":"array","items":{"$ref":"#/components/schemas/SubsidiaryDTO"}},"establishments":{"description":"The establishments of the company, including physical locations where business activities are conducted.","type":"array","items":{"$ref":"#/components/schemas/EstablishmentDTO"}},"otherKeyPersons":{"description":"Other key persons associated with the company who do not have legal signing authority, such as board members, auditors, and compliance officers.","type":"array","items":{"$ref":"#/components/schemas/OtherKeyPersonDTO"}},"graph":{"description":"Ownership graph: the entities (`nodes`) and ownership relationships (`edges`) discovered while traversing the company structure, plus a human-readable `description`, a `mermaidDiagram` rendering, and traversal `metadata`. Individual nodes carry UBO flags (`flags.isUbo`, `flags.uboCalculationMethod`) and `totalOwnershipPercentage`.","allOf":[{"$ref":"#/components/schemas/EnhancedGraphResultDTO"}]},"documents":{"$ref":"#/components/schemas/DocumentsDTO"},"companyRelationships":{"type":"array","items":{"$ref":"#/components/schemas/CompanyRelationshipDTO"}},"dataSources":{"description":"Per-field data source provenance for each entity. Keys are field names, values describe the origin of the data.","allOf":[{"$ref":"#/components/schemas/DataSourcesDTO"}]},"enrichmentReport":{"type":"string","description":"Human-readable summary of enrichment results when agenticEnrichment was requested."}},"required":["request"]},"CreateOnboardingRequestDTO":{"type":"object","properties":{"id":{"type":"string","example":"932884117","description":"The company id. In some countries, this might be a concatenation of the registry and city (e.g., in Germany: \"Augsburg HRB 34617\"). The search function will always return a usable company number. Check the documentation to see which number format is used for each country."},"countryCode":{"type":"string","enum":["AT","BE","BG","CH","CN","CZ","CY","DE","DK","EE","ES","FI","FR","GB","GG","GR","HK","HR","HU","IE","IS","IT","JE","LI","LU","LV","MC","MT","MU","NL","NO","PL","PT","RO","RU","SE","SG","SI","SK","VG","JP","HN","PA","MX","CO","EC","BM","AR","CL","UY","PY","BO","DO","AU","AL","TN","XK","BZ","NI","ME","IL","MK","MA","AG","AI","MS","CW","BA","BR","GI","IM","KY","US-FL","US-CO","US-IL","US-MA","US-MD","US-MI","US-TX","US-DE","UA","US-NY","US-NJ","US-NM","US-OH","US-WA","US-TN","US-GA","US-MN","US-MO","US-NV","RS","US-PA","US-WY","US-CT","US-UT","US-IA","US-ID","US-AZ","US-VA","US-MS","US-CA","US-OR","US-KY","US-NE","US-NC","US-AR","US-WI","US-SC","US-AL","US-AK","US-DC","US-IN","US-ME","US-MT","US-OK","US-SD","US-LA","US-WV","US-ND","US-VT","US-KS","US-RI","US-HI","LT","MD","MH","US-NH","US-PR","CA-FED","CA-ON","CA-QC","CA-BC","CA-AB","CA-MB","CA-SK","CA-NS","CA-NL","CA-PE","CA-YT","CA-NT","NC","PF","NZ","FO","PH","TH","MN","MV","BH","KR","TW"],"example":"FR","description":"The country code in ISO 3166-1 alpha-2 format (e.g., \"FR\" for France, \"DE\" for Germany)."},"dataPoints":{"type":"array","items":{"type":"string","enum":["companyProfile"]},"deprecated":true,"description":"Legacy parameter, ignored by this endpoint. Omit it. The endpoint retrieves company in prefill mode. For new integrations, use POST /v2/company with mode prefill and explicit dataPoints."},"metadata":{"type":"object","additionalProperties":{"type":"string","maxLength":500},"description":"Arbitrary key-value string pairs to associate with the request. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated)."}},"required":["id","countryCode"]},"CreateWorkspaceDto":{"type":"object","properties":{"name":{"type":"string","description":"Workspace name, unique within the account. This is the value you pass in the `x-topograph-workspace-id` header and in `/v2/workspaces/{name}` paths, not the UUID `id` returned on creation. Reserved: `default`.","example":"branch-paris","pattern":"^[a-zA-Z0-9_:-]+$","maxLength":64},"legalName":{"type":"string","description":"Display-friendly legal name used in reporting and invoices.","example":"Acme Paris SAS","maxLength":255},"uboEnabled":{"type":"boolean","description":"Whether this workspace can access ultimate-beneficial-owner (UBO) data. Enabled by default. Only enable this for AML-obliged entities — UBO data carries regulatory obligations under AML law.","example":true,"default":true}},"required":["name","legalName"]},"UpdateWorkspaceDto":{"type":"object","properties":{"legalName":{"type":"string","description":"New display-friendly legal name.","example":"Acme Paris SAS","maxLength":255},"uboEnabled":{"type":"boolean","description":"Whether this workspace can access ultimate-beneficial-owner (UBO) data. Enabled by default. Only enable this for AML-obliged entities — UBO data carries regulatory obligations under AML law.","example":true}}},"CreateDevelopmentAccountDto":{"type":"object","properties":{"name":{"type":"string","description":"Environment name, unique within the organisation. Lowercase letters, digits and hyphens. `live`, `production` and `prod` are reserved.","example":"sandbox","pattern":"^[a-z0-9][a-z0-9-]{0,31}$","maxLength":32},"simulateLatency":{"type":"boolean","description":"Wait for the country’s published latency before answering, instead of answering instantly. Off by default; the `DELAY_*` test identifiers work either way.","default":false}},"required":["name"]},"UpdateDevelopmentAccountDto":{"type":"object","properties":{"simulateLatency":{"type":"boolean","description":"Wait for the country’s published latency before answering, instead of answering instantly."},"fixedLatencyMs":{"type":"object","description":"Answer every datapoint after exactly this many milliseconds, for tests that assert on timing. Overrides `simulateLatency`. Send `null` to go back to instant (or to simulated) responses.","example":2500,"minimum":0,"maximum":600000,"nullable":true}}},"SetSandboxWalletDto":{"type":"object","properties":{"balanceInCreditCents":{"type":"number","description":"The exact virtual balance to set, in credit cents (1 credit = 100 cents).","example":50000,"minimum":0},"autoRefill":{"type":"boolean","description":"Whether the wallet refills itself automatically when a debit would leave it under the threshold. Turn OFF to test genuine credit depletion down to insufficient_funds.","example":false}},"required":["balanceInCreditCents"]},"TriggerMonitorWebhookDto":{"type":"object","properties":{"monitorId":{"type":"string","description":"One of your own monitors, as returned by POST /v2/monitors. The event is built from that monitor — its id, its company, its metadata — exactly as a real one is.","example":"mon_01H8XGJWBWBAQ4V9E3F1S9M4KZ"},"event":{"type":"string","description":"Which monitor event to deliver.","enum":["monitor.notification","monitor.datapoint_blocked","monitor.datapoint_unblocked"],"default":"monitor.notification"},"changeCategories":{"type":"array","description":"Change categories to report (`monitor.notification` only).","example":["status","address"],"items":{"type":"string","enum":["status","address","ownership","financial","other","disappeared"]}},"monitorHasBeenDeactivated":{"type":"boolean","description":"Report the monitor as deactivated (`monitor.notification` only) — what a real `disappeared` change sets. The monitor itself is not modified."},"datapoint":{"type":"string","description":"Datapoint the gate event is about (`monitor.datapoint_*` only).","example":"ultimateBeneficialOwners","default":"ultimateBeneficialOwners"}},"required":["monitorId"]},"ResetSandboxDto":{"type":"object","properties":{"keepWallet":{"type":"boolean","description":"Leave the wallet balance as it is. Use when a suite deliberately set a low balance to test depletion and only wants the history cleared.","default":false}}},"CreateSandboxFixtureDto":{"type":"object","properties":{"countryCode":{"type":"string","description":"Country the company belongs to.","example":"FR"},"identifier":{"type":"string","description":"Identifier the fixture answers to. Omit and one is minted in the country’s own format, which is what you usually want — the point of a fixture is the data, not the number.","example":"552100554"},"company":{"type":"object","description":"The company, as much or as little of it as you care about. Everything you leave out is still generated, so pinning one field takes one field. Field names match the company datapoint (legalName, status, legalAddress, legalForm, incorporationDate, …).","example":{"legalName":"Acme Trading BV","status":{"localName":"Ontbonden","active":false}},"additionalProperties":true}},"required":["countryCode","company"]},"UpdateSandboxFixtureDto":{"type":"object","properties":{"company":{"type":"object","description":"Fields to change. Merged over the stored fixture, which is itself merged over generated data.","additionalProperties":true}},"required":["company"]},"AutoTopupSummaryDto":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the account auto-recharges when the balance drops below the threshold.","example":true},"thresholdInCreditCents":{"type":"number","description":"Balance (in credit cents) at or below which an auto-topup is triggered.","example":5000,"minimum":0},"amountInCreditCents":{"type":"number","description":"Amount (in credit cents) added to the balance on each auto-topup.","example":10000,"minimum":0}},"required":["enabled","thresholdInCreditCents","amountInCreditCents"]},"LowBalanceTierDto":{"type":"object","properties":{"tier":{"type":"string","description":"Severity tier name. Must be unique within the array.","enum":["warning","critical","depleted"],"example":"warning"},"cents":{"type":"number","description":"Threshold in cents (integer, same currency as the account). A notification fires when the account balance drops at or below this value.","example":100000,"minimum":0}},"required":["tier","cents"]},"BalanceResponseDto":{"type":"object","properties":{"balanceInCreditCents":{"type":"number","description":"Current remaining account balance, in credit cents.","example":42350},"status":{"type":"string","description":"Derived health of the balance. `depleted` when the balance is at or below zero (new work is blocked); `low` when it is at or below the highest configured low-balance threshold; otherwise `ok`.","enum":["ok","low","depleted"],"example":"ok"},"autoTopup":{"description":"Read-only auto-topup posture for the account.","allOf":[{"$ref":"#/components/schemas/AutoTopupSummaryDto"}]},"lowBalanceThresholds":{"description":"Resolved low-balance thresholds. A low_balance notification fires when the balance drops at or below a tier. Returned here so a client can interpret `status` and surface the same thresholds it is alerted on.","type":"array","items":{"$ref":"#/components/schemas/LowBalanceTierDto"}}},"required":["balanceInCreditCents","status","autoTopup","lowBalanceThresholds"]},"HighUsageTierDto":{"type":"object","properties":{"tier":{"type":"string","description":"Severity tier name. Must be unique within the array.","enum":["warning","critical"],"example":"warning"},"cents":{"type":"number","description":"Spend threshold in cents over the rolling period. A notification fires when the rolling-period spend is at or above this value.","example":100000,"minimum":0}},"required":["tier","cents"]},"ResolvedBillingNotificationConfigDto":{"type":"object","properties":{"lowBalanceEnabled":{"type":"boolean","description":"Master toggle for low-balance notifications.","example":false},"lowBalanceEmailEnabled":{"type":"boolean","description":"Route low-balance notifications via email.","example":true},"lowBalanceWebhookEnabled":{"type":"boolean","description":"Route low-balance notifications via webhook.","example":true},"lowBalanceTiers":{"description":"Resolved low-balance tiers.","type":"array","items":{"$ref":"#/components/schemas/LowBalanceTierDto"}},"globalHighUsageEnabled":{"type":"boolean","description":"Master toggle for global (account-aggregate) high-usage notifications.","example":false},"globalHighUsageEmailEnabled":{"type":"boolean","description":"Route global high-usage notifications via email.","example":true},"globalHighUsageWebhookEnabled":{"type":"boolean","description":"Route global high-usage notifications via webhook.","example":true},"globalHighUsagePeriodMinutes":{"type":"number","description":"Rolling window, in minutes, for global high-usage evaluation.","example":1440},"globalHighUsageTiers":{"description":"Resolved global high-usage tiers.","type":"array","items":{"$ref":"#/components/schemas/HighUsageTierDto"}},"highUsageEnabled":{"type":"boolean","description":"Master toggle for per-workspace high-usage notifications.","example":false},"highUsageEmailEnabled":{"type":"boolean","description":"Route per-workspace high-usage notifications via email.","example":true},"highUsageWebhookEnabled":{"type":"boolean","description":"Route per-workspace high-usage notifications via webhook.","example":true},"highUsagePeriodMinutes":{"type":"number","description":"Rolling window, in minutes, for per-workspace high-usage evaluation.","example":1440},"highUsageTiers":{"description":"Resolved per-workspace high-usage tiers (applied as defaults to every workspace).","type":"array","items":{"$ref":"#/components/schemas/HighUsageTierDto"}},"autoTopupNotificationsEnabled":{"type":"boolean","description":"Master toggle for auto-topup outcome notifications.","example":false},"autoTopupEmailEnabled":{"type":"boolean","description":"Route auto-topup notifications via email.","example":true},"autoTopupWebhookEnabled":{"type":"boolean","description":"Route auto-topup notifications via webhook.","example":true}},"required":["lowBalanceEnabled","lowBalanceEmailEnabled","lowBalanceWebhookEnabled","lowBalanceTiers","globalHighUsageEnabled","globalHighUsageEmailEnabled","globalHighUsageWebhookEnabled","globalHighUsagePeriodMinutes","globalHighUsageTiers","highUsageEnabled","highUsageEmailEnabled","highUsageWebhookEnabled","highUsagePeriodMinutes","highUsageTiers","autoTopupNotificationsEnabled","autoTopupEmailEnabled","autoTopupWebhookEnabled"]},"UpdateBillingNotificationConfigDto":{"type":"object","properties":{"lowBalanceEnabled":{"type":"boolean","description":"Master toggle for low-balance notifications. Defaults to false on new accounts (strictly opt-in).","example":true},"lowBalanceEmailEnabled":{"type":"boolean","description":"Route low-balance notifications via email. Applied when lowBalanceEnabled is true.","example":true},"lowBalanceWebhookEnabled":{"type":"boolean","description":"Route low-balance notifications via webhook. Applied when lowBalanceEnabled is true.","example":true},"lowBalanceTiers":{"description":"Ordered list of low-balance tiers. Each tier fires once when the account balance drops at or below its `cents` threshold. Tier names must be unique.","minItems":1,"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/LowBalanceTierDto"}},"globalHighUsageEnabled":{"type":"boolean","description":"Master toggle for global (account-aggregate) high-usage notifications. Defaults to false on new accounts.","example":false},"globalHighUsageEmailEnabled":{"type":"boolean","description":"Route global high-usage notifications via email.","example":true},"globalHighUsageWebhookEnabled":{"type":"boolean","description":"Route global high-usage notifications via webhook.","example":true},"globalHighUsagePeriodMinutes":{"type":"number","description":"Rolling window, in minutes, used to sum account-aggregate spend when evaluating global high-usage tiers. Min 5 (5 minutes), max 43200 (30 days).","example":1440,"minimum":5,"maximum":43200},"globalHighUsageTiers":{"description":"Global high-usage tiers. Fires when the sum of spend across ALL workspaces (plus the account-wide bucket) over the rolling window meets-or-exceeds `cents`.","minItems":1,"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/HighUsageTierDto"}},"highUsageEnabled":{"type":"boolean","description":"Master toggle for per-workspace high-usage notifications. These thresholds are applied individually to each workspace; a workspace can override them via the workspace-override endpoint.","example":false},"highUsageEmailEnabled":{"type":"boolean","description":"Route per-workspace high-usage notifications via email.","example":true},"highUsageWebhookEnabled":{"type":"boolean","description":"Route per-workspace high-usage notifications via webhook.","example":true},"highUsagePeriodMinutes":{"type":"number","description":"Rolling window, in minutes, used to sum per-workspace spend when evaluating high-usage tiers. Min 5, max 43200.","example":1440,"minimum":5,"maximum":43200},"highUsageTiers":{"description":"Per-workspace high-usage tiers. Fires when a single workspace's spend over the rolling window meets-or-exceeds `cents`.","minItems":1,"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/HighUsageTierDto"}},"autoTopupNotificationsEnabled":{"type":"boolean","description":"Master toggle for auto-topup outcome notifications (succeeded / failed). Distinct from Account.autoTopupEnabled, which controls the charge itself. Defaults to false on new accounts.","example":false},"autoTopupEmailEnabled":{"type":"boolean","description":"Route auto-topup outcome notifications via email.","example":true},"autoTopupWebhookEnabled":{"type":"boolean","description":"Route auto-topup outcome notifications via webhook.","example":true}}},"BillingNotificationEventDto":{"type":"object","properties":{"id":{"type":"string","description":"Event ID.","example":"e8f4c2a1-3b7d-4e9f-8a1c-6b5d3e2a9f01"},"kind":{"type":"string","description":"Notification kind.","enum":["low_balance","high_usage","auto_topup"],"example":"low_balance"},"identifier":{"type":"string","description":"Tier name (`warning` / `critical` / `depleted`) for low_balance and high_usage, or outcome (`succeeded` / `failed`) for auto_topup.","example":"warning"},"accountId":{"type":"string","description":"Account the event belongs to.","example":"acc_01H8XYZ..."},"workspaceId":{"type":"string","description":"Workspace the event was scoped to, or null for account-level events.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","nullable":true},"dedupKey":{"type":"string","description":"Dedup key used to enforce one-fire-per-threshold-per-period.","example":"low_balance:warning:acc_01H8XYZ:2026-04-22"},"firedAt":{"type":"string","description":"When the event fired.","example":"2026-04-22T08:12:34.567Z","format":"date-time"},"payload":{"type":"object","description":"Kind-specific payload (threshold cents, period info, auto-topup details, etc.).","additionalProperties":true,"example":{"tierCents":100000,"balanceCents":85000}},"emailSent":{"type":"boolean","description":"Whether an email was dispatched.","example":true},"webhookSent":{"type":"boolean","description":"Whether a webhook was dispatched.","example":true}},"required":["id","kind","identifier","accountId","dedupKey","firedAt","payload","emailSent","webhookSent"]},"BillingNotificationWorkspaceOverrideDto":{"type":"object","properties":{"id":{"type":"string","description":"Override row ID.","example":"f2b5e0b8-1a3c-4f7e-9d2a-7c6b8a1d4e52"},"workspaceId":{"type":"string","description":"Workspace ID this override applies to.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"createdAt":{"type":"string","description":"Row creation timestamp.","example":"2026-04-15T12:34:56.789Z","format":"date-time"},"updatedAt":{"type":"string","description":"Row last-update timestamp.","example":"2026-04-22T08:12:34.567Z","format":"date-time"},"highUsageEnabled":{"type":"boolean","description":"Override for master high-usage toggle. Null means \"inherit\".","example":true,"nullable":true},"highUsageEmailEnabled":{"type":"boolean","description":"Override for email routing. Null means \"inherit\".","example":true,"nullable":true},"highUsageWebhookEnabled":{"type":"boolean","description":"Override for webhook routing. Null means \"inherit\".","example":true,"nullable":true},"highUsagePeriodMinutes":{"type":"number","description":"Override for rolling window minutes. Null means \"inherit\".","example":720,"nullable":true},"highUsageTiers":{"description":"Override for tier thresholds. Null means \"inherit\".","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/HighUsageTierDto"}}},"required":["id","workspaceId","createdAt","updatedAt"]},"WorkspaceBillingNotificationViewDto":{"type":"object","properties":{"accountConfig":{"description":"Fully resolved account-level config (defaults merged).","allOf":[{"$ref":"#/components/schemas/ResolvedBillingNotificationConfigDto"}]},"workspaceOverride":{"description":"Raw workspace-override row, or null if the workspace inherits everything.","nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/BillingNotificationWorkspaceOverrideDto"}]}},"required":["accountConfig"]},"UpdateWorkspaceHighUsageOverrideDto":{"type":"object","properties":{"highUsageEnabled":{"type":"boolean","description":"Override the account-level master toggle for per-workspace high-usage notifications. Undefined means \"inherit from account config\".","example":true},"highUsageEmailEnabled":{"type":"boolean","description":"Override the account-level email routing for high-usage notifications for this workspace.","example":true},"highUsageWebhookEnabled":{"type":"boolean","description":"Override the account-level webhook routing for high-usage notifications for this workspace.","example":true},"highUsagePeriodMinutes":{"type":"number","description":"Override the rolling window, in minutes, used to sum this workspace's spend when evaluating high-usage tiers. Min 5, max 43200.","example":1440,"minimum":5,"maximum":43200},"highUsageTiers":{"description":"Override the high-usage tiers for this workspace specifically. Fires when the workspace spend over the rolling window meets-or-exceeds `cents`. Tier names must be unique.","minItems":1,"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/HighUsageTierDto"}}}},"DeleteWorkspaceOverrideResponseDto":{"type":"object","properties":{"ok":{"type":"boolean","description":"Always true on success (the operation is idempotent).","example":true}},"required":["ok"]}}},"security":[{"x-api-key":[]}]}