Data dictionary
184 attributes across six families. This page covers the shape and the null semantics; the per-field table is served live from GET /v1/schema so it cannot drift from the API.
The six families
| Family | Attributes | Typical coverage |
|---|---|---|
| Identity — names, IDs, register keys | 38 | 99.6% |
| Status and legal form | 21 | 98.1% |
| Geography — seats, branches, communes | 34 | 96.4% |
| Activity — NACE, SIC, trade descriptions | 26 | 88.7% |
| Financials and size | 42 | 61.2% Tier 1 |
| Relations and brands | 23 | 74.9% |
Every attribute has the same envelope
Attribute shape
{ "value": "Nordwind Logistik GmbH", "since": "2019-04-02", "until": null, "source_id": "src_de_hrb_148902_2019_0412", "source_class": "register", "published": "2019-04-05", "ingested_at": "2019-04-05T09:12:44Z", "confidence": 1.0 }
confidence is 1.0 for anything a register stated directly. Below 1.0 means we derived it — a NACE code inferred from a trade description, for instance — and source_class says derived rather than register.
Null means one of four things
- `not_published` — the register does not publish this field for this entity type. Common and correct.
- `not_yet_filed` — the register would publish it, but nothing has been filed. Usually a young company.
- `before_as_of` — the field exists today but no filing established it by your as_of date.
- `suppressed` — the register has suppressed a person's details, typically for personal safety. We suppress them too, on the same cadence.
Worth knowing
A field is never null because we did not bother. If we hold nothing, the response says which of the four it is.
Identifiers you can key on
| Identifier | Stable across | Coverage |
|---|---|---|
| entity_id | Renames, mergers, address moves | 100% |
| Register number + authority | Renames | 99.6% |
| LEI | Renames; not all entities have one | 4.1% |
| VAT number | Renames; reissued on some restructures | 62.8% |
| EUID | Renames; EU only | 71.4% |
| Domain | Nothing — domains change hands | 38.2% |
Only the first row is stable across everything, which is the argument for storing it. See the quickstart.
Try it against your own data
The Developer plan is free forever and needs no card. 2,500 credits is enough to answer the only question that matters: does it resolve your records.