nordic-data

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['country', 'query'], 'properties': {'query': {'type': 'string', 'minLength': 2, 'description': 'Partial address â\x80\x94 street name, postcode, city, or any combination. Min 2 characters.'}, 'country': {'enum': ['dk', 'no', 'se', 'fi', 'fr'], 'type': 'string', 'description': 'ISO 3166-1 alpha-2 country code, lowercase. Only dk, no, se, fi and fr are supported.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'results': {'type': ['array', 'null'], 'items': {'type': 'object', 'properties': {'city': {'type': ['string', 'null']}, 'number': {'type': ['string', 'null'], 'description': 'House number.'}, 'source': {'type': ['string', 'null'], 'description': 'DAWA / Geonorge / BAN / Nominatim.'}, 'street': {'type': ['string', 'null']}, 'confidence': {'type': ['number', 'null'], 'description': 'Match confidence 0-1.'}, 'postalCode': {'type': ['string', 'null']}, 'coordinates': {'type': ['object', 'null'], 'description': 'WGS-84 {lat, lng}.', 'additionalProperties': True}, 'displayName': {'type': ['string', 'null'], 'description': 'Formatted address suitable for display.'}}, 'additionalProperties': True}, 'description': 'Ranked address candidates, best match first.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['path'], 'properties': {'path': {'type': 'string', 'minLength': 1, 'description': "Concrete endpoint path, e.g. '/api/company/dk/22756214'. Path templates with {placeholders} are also accepted when you supply the values in `params`."}, 'method': {'type': 'string', 'default': 'GET', 'minLength': 1, 'description': 'HTTP method to use. Read-only methods only: GET or HEAD, plus POST solely for the allowlisted screening query endpoints (/api/sanctions/screen, /api/adverse/screen, /api/peps/nl/screen). Defaults to GET.'}, 'params': {'type': 'object', 'description': 'Parameters for the call. Values whose keys match {placeholders} in the path are substituted into the path. Remaining values become query-string params for GET/DELETE, or the JSON request body for POST/PUT/PATCH.', 'additionalProperties': {}}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['country', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'National company identifier â\x80\x94 same format as lookup_company.'}, 'country': {'enum': ['dk', 'no', 'se', 'fi'], 'type': 'string', 'description': 'ISO 3166-1 alpha-2 country code, lowercase. Only dk, no, se and fi are supported.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'company': {'type': ['object', 'null'], 'description': 'Registry data â\x80\x94 same shape as lookup_company output.', 'additionalProperties': True}, 'industryStats': {'type': ['object', 'null'], 'properties': {'data': {'type': ['array', 'null'], 'items': {'type': 'object', 'additionalProperties': True}, 'description': 'Time series of {year, value, unit} rows.'}, 'source': {'type': ['string', 'null']}, 'available': {'type': ['boolean', 'null'], 'description': "False when no statistics exist for the company's industry code."}}, 'description': 'National industry statistics (DST for DK, SSB for NO, etc.).', 'additionalProperties': True}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['siren'], 'properties': {'siren': {'type': 'string', 'pattern': '^\\d{9}$', 'description': '9-digit French SIREN number. Examples: 652014051 (Carrefour), 775670417 (LVMH). No spaces or punctuation.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'count': {'type': ['integer', 'null'], 'description': 'Number of history events derived.'}, 'sigle': {'type': ['string', 'null'], 'description': 'Acronym / short name, if any.'}, 'siren': {'type': ['string', 'null'], 'description': '9-digit SIREN echoed back.'}, 'events': {'type': ['array', 'null'], 'items': {'type': 'object', 'properties': {'to': {'type': ['string', 'null'], 'description': 'New value of the field after the change.'}, 'date': {'type': ['string', 'null'], 'description': 'ISO-8601 start date of the period.'}, 'from': {'type': ['string', 'null'], 'description': 'Previous value of the field. Null for initial: events.'}, 'type': {'type': ['string', 'null'], 'description': 'Event type. One of: initial:name, initial:usage_name, initial:activity, initial:status, initial:legal_form, initial:employer_flag, initial:ess_flag, name, usage_name, activity, status, legal_form, employer_flag, ess_flag.'}, 'endDate': {'type': ['string', 'null'], 'description': 'ISO-8601 end date of the period; null for the currently-active period.'}}, 'additionalProperties': True}, 'description': "Chronologically ordered events. Each event has 'initial:<field>' type for the baseline period or a plain field name for subsequent changes."}, 'source': {'type': ['string', 'null'], 'description': "Upstream data source â\x80\x94 'api.insee.fr'."}, 'fetchedAt': {'type': ['string', 'null'], 'description': 'ISO-8601 timestamp when the data was fetched upstream.'}, 'sourceNote': {'type': ['string', 'null'], 'description': 'Provenance note describing the upstream API and field set used.'}, 'periodCount': {'type': ['integer', 'null'], 'description': 'Number of bitemporal periods returned by INSEE.'}, 'dateCreation': {'type': ['string', 'null'], 'description': 'ISO-8601 date the legal entity was created.'}, 'categorieEntreprise': {'type': ['string', 'null'], 'description': 'INSEE company size category: PME, ETI, GE.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['path'], 'properties': {'path': {'type': 'string', 'minLength': 1, 'description': "Endpoint path from list_endpoints, e.g. '/api/company/{country}/{id}'. Concrete paths like '/api/company/dk/22756214' are also accepted."}, 'method': {'type': 'string', 'default': 'GET', 'minLength': 1, 'description': 'HTTP method for the endpoint (e.g. GET, POST). Defaults to GET. Must be a method the endpoint actually defines.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['country', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'National company identifier â\x80\x94 same format as lookup_company (e.g. DK CVR 8 digits, NO orgnr 9 digits).'}, 'country': {'enum': ['dk', 'no', 'se', 'fi', 'ie', 'uk', 'fr', 'de', 'cz', 'pl', 'lv', 'ee', 'nl', 'be', 'lu'], 'type': 'string', 'description': 'ISO 3166-1 alpha-2 country code, lowercase.'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'search': {'type': 'string', 'description': "Optional case-insensitive keyword filter, matched against each endpoint's path, summary, and tags. Examples: 'sanction', 'address', 'cvr', 'history', 'vat', 'lei'. Omit to list every available data endpoint."}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['country', 'id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'National company identifier. DK=CVR (8 digits), NO=orgnr (9), SE=orgnr (10), FI=Y-tunnus (NNNNNNN-D), IE=CRO (1-7), UK=8 chars, FR=SIREN (9), DE=HRB number, CZ=IÄ\x8cO (8), PL=NIP (10) or KRS (10), LV=11 digits, EE=8 digits, NL=KvK (8 digits), BE=BCE/KBO (10 digits), LU=RCSL (B + digits).'}, 'country': {'enum': ['dk', 'no', 'se', 'fi', 'ie', 'uk', 'fr', 'de', 'cz', 'pl', 'lv', 'ee', 'nl', 'be', 'lu'], 'type': 'string', 'description': 'ISO 3166-1 alpha-2 country code, lowercase. One of: dk, no, se, fi, ie, uk, fr, de, cz, pl, lv, ee, nl, be, lu.'}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'id': {'type': ['string', 'null'], 'description': 'National company identifier.'}, 'name': {'type': ['string', 'null'], 'description': 'Registered legal name.'}, 'source': {'type': ['string', 'null'], 'description': 'Upstream registry name (CVR, Brønnøysund, etc.).'}, 'status': {'type': ['string', 'null'], 'description': 'Registry status, e.g. active, dissolved, bankrupt.'}, 'address': {'type': ['object', 'string', 'null'], 'description': 'Registered address: an object ({street, city, zip}) or a single formatted string, depending on the registry.', 'additionalProperties': True}, 'country': {'type': ['string', 'null'], 'description': 'Country code or name as returned by the source registry.'}, 'founded': {'type': ['string', 'null'], 'description': 'ISO-8601 founding date, if known.'}, 'industry': {'type': ['object', 'null'], 'description': 'Industry classification ({code, description}; NACE or national code).', 'additionalProperties': True}, 'fetchedAt': {'type': ['string', 'null'], 'description': 'ISO-8601 timestamp when the data was fetched upstream.'}, 'legalForm': {'type': ['object', 'string', 'null'], 'description': 'Legal form: an object ({code, description}) or a string, depending on the registry.', 'additionalProperties': True}, 'vatRegistered': {'type': ['boolean', 'null'], 'description': 'Whether the company is VAT-registered, where the registry reports it.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['mode'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': "National company ID. Required when mode='reverse'."}, 'lei': {'type': 'string', 'maxLength': 20, 'minLength': 20, 'description': "20-character ISO 17442 Legal Entity Identifier. Required when mode='lei'."}, 'mode': {'enum': ['lei', 'reverse'], 'type': 'string', 'description': "'lei' = look up by LEI directly. 'reverse' = look up LEI from national company number."}, 'country': {'enum': ['dk', 'no', 'se', 'fi', 'ie', 'uk', 'fr', 'de', 'cz', 'pl', 'lv', 'ee', 'nl', 'be', 'lu'], 'type': 'string', 'description': "ISO 3166-1 alpha-2 country code, lowercase. Required when mode='reverse'."}, 'include_relationships': {'type': 'boolean', 'default': False, 'description': "If true, also fetch parent and child entities. Only applies when mode='lei'."}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'lei': {'type': ['string', 'null'], 'description': "20-character ISO 17442 identifier (mode='lei')."}, 'count': {'type': ['integer', 'null'], 'description': "mode='reverse': number of LEI records found."}, 'found': {'type': ['boolean', 'null'], 'description': "mode='reverse': whether any LEI exists for the national ID."}, 'source': {'type': ['string', 'null']}, 'status': {'type': ['string', 'null'], 'description': 'Entity status, e.g. ACTIVE / INACTIVE.'}, 'records': {'type': ['array', 'null'], 'items': {'type': 'object', 'additionalProperties': True}, 'description': "mode='reverse': matching LEI records (same shape as a mode='lei' result)."}, 'fetchedAt': {'type': ['string', 'null']}, 'legalForm': {'type': ['string', 'null'], 'description': 'ISO 20275 entity legal form code.'}, 'legalName': {'type': ['string', 'null'], 'description': "Registered legal name (mode='lei')."}, 'jurisdiction': {'type': ['string', 'null']}, 'legalAddress': {'type': ['object', 'null'], 'additionalProperties': True}, 'registeredAs': {'type': ['string', 'null'], 'description': 'National registry identifier.'}, 'registration': {'type': ['object', 'null'], 'description': 'GLEIF registration metadata (initial, lastUpdate, status ISSUED/LAPSED/..., nextRenewal).', 'additionalProperties': True}, 'relationships': {'type': ['object', 'null'], 'properties': {'parent': {'type': ['object', 'null'], 'description': '{directParent, ultimateParent, isUltimate}; directParent/ultimateParent are null for a top-level entity.', 'additionalProperties': True}, 'children': {'type': ['object', 'null'], 'description': 'Paginated subsidiaries: {total, page, totalPages, children: [LEI records]}.', 'additionalProperties': True}}, 'description': 'Only present when include_relationships=true.', 'additionalProperties': True}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['names'], 'properties': {'fuzzy': {'type': 'boolean', 'default': True, 'description': 'Enable fuzzy matching. Default true.'}, 'names': {'type': 'array', 'items': {'anyOf': [{'type': 'string', 'minLength': 1}, {'type': 'object', 'required': ['name'], 'properties': {'name': {'type': 'string', 'minLength': 1}, 'birth_year': {'type': 'integer', 'maximum': 2100, 'minimum': 1850, 'description': "Birth year of the screened person, if known. When the listed person's birth year is known and differs, the hit is never 'confirmed' (same name, different person)."}, 'entity_type': {'enum': ['company', 'person', 'auto'], 'type': 'string', 'description': "What the screened party is. 'company': a hit on a listed individual is never 'confirmed' (a company is not a natural person). 'person': a hit on a listed entity is never 'confirmed'. 'auto' (default): a legal form in the name (A/S, Ltd, GmbH, AB, Oy â\x80¦) marks it as a company."}}, 'additionalProperties': False}]}, 'maxItems': 1000, 'minItems': 1, 'description': 'Names to screen, max 1000 per call. Each item is a plain name, or { name, entity_type, birth_year } to say per name whether it is a company or a person (e.g. a company plus its key persons in one call).'}, 'min_score': {'type': 'number', 'maximum': 1, 'minimum': 0, 'description': 'Minimum fuzzy score for a candidate to be returned, 0-1. Default 0.85. Lower values return more low-confidence candidates; only candidates â\x89¥ 0.95 can ever be classified as a match.'}, 'birth_year': {'$ref': '#/properties/names/items/anyOf/1/properties/birth_year', 'description': 'Default birth year for all names that do not set their own. Only meaningful when screening one person.'}, 'entity_type': {'$ref': '#/properties/names/items/anyOf/1/properties/entity_type', 'description': "Default entity type for all names that do not set their own: 'company', 'person' or 'auto' (default). Set 'company' when screening a company name â\x80\x94 a hit on a listed individual is then never 'confirmed'."}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'total': {'type': ['integer', 'null'], 'description': 'Number of names screened.'}, 'matched': {'type': ['integer', 'null'], 'description': 'Number of names with matched=true.'}, 'results': {'type': ['array', 'null'], 'items': {'type': 'object', 'properties': {'hits': {'type': ['array', 'null'], 'items': {'type': 'object', 'properties': {'name': {'type': ['string', 'null'], 'description': 'Listed entity name.'}, 'type': {'type': ['string', 'null'], 'description': 'individual / entity.'}, 'score': {'type': ['number', 'null'], 'description': 'Fuzzy match score 0-1.'}, 'source': {'type': ['string', 'null'], 'description': 'Source list (UN, EU FSF, UK Sanctions List (FCDO), US OFAC SDN, OpenSanctions PEPs).'}, 'programs': {'type': ['array', 'null'], 'items': {'type': 'string'}, 'description': 'Sanctions programmes.'}, 'countries': {'type': ['array', 'null'], 'items': {'type': 'string'}}, 'classification': {'type': ['string', 'null'], 'description': 'none / potential_match / confirmed.'}}, 'additionalProperties': True}, 'description': "Fuzzy candidates, each with its own classification ('none' = not flagged)."}, 'count': {'type': ['integer', 'null'], 'description': 'Number of fuzzy candidates returned, including unflagged low-confidence ones â\x80\x94 not a match count.'}, 'query': {'type': ['string', 'null'], 'description': 'The original input name.'}, 'matched': {'type': ['boolean', 'null'], 'description': 'The screening outcome for this name: true only if at least one hit is classified as a match.'}, 'topScore': {'type': ['number', 'null'], 'description': 'Highest fuzzy score among candidates; null when there are none. A high score alone is not a match â\x80\x94 see classification.'}, 'flaggedCount': {'type': ['integer', 'null'], 'description': 'Number of hits classified as a match.'}, 'classification': {'type': ['string', 'null'], 'description': 'Outcome for this name: none / potential_match / confirmed.'}, 'queryEntityType': {'type': ['string', 'null'], 'description': 'How the name was treated: company / person / unknown (from entity_type, or a legal form in the name).'}, 'requiresManualReview': {'type': ['boolean', 'null'], 'description': 'True when hits need human verification.'}}, 'additionalProperties': True}, 'description': 'One entry per input name, in submission order.'}, 'disclaimer': {'type': ['string', 'null']}, 'sourcesUsed': {'type': ['array', 'null'], 'items': {'type': 'object', 'additionalProperties': True}, 'description': "The lists this answer was actually screened against: key (un / eu_fsf / gb_fcdo / us_ofac_sdn / peps), name, publisher, entries, listUpdated (the list's own last change), loadedAt, stale. Quote this, not a fixed list, when stating what was screened."}, 'indexUpdated': {'type': ['object', 'null'], 'description': 'ISO-8601 last refresh per source list.', 'additionalProperties': True}, 'sourcesUnavailable': {'type': ['array', 'null'], 'description': 'Lists that could not be checked on this call; non-empty means the screening is incomplete.'}}, 'additionalProperties': True}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['country', 'vat_number'], 'properties': {'country': {'enum': ['AT', 'BE', 'BG', 'CY', 'CZ', 'DE', 'DK', 'EE', 'EL', 'ES', 'FI', 'FR', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV', 'MT', 'NL', 'PL', 'PT', 'RO', 'SE', 'SI', 'SK'], 'type': 'string', 'description': 'VIES country code, UPPERCASE. Supports the 27 EU member states. Use EL for Greece (not GR). The United Kingdom (GB) and Norway (NO) are not supported.'}, 'vat_number': {'type': 'string', 'minLength': 1, 'description': "VAT number WITHOUT country prefix â\x80\x94 just the digits/characters. Example: for DK29403473, pass '29403473'."}}, 'additionalProperties': False}

{'type': 'object', 'properties': {'name': {'type': ['string', 'null'], 'description': 'Registered company name. null when the member state does not disclose trader details via VIES (e.g. DE, ES) â\x80\x94 the number can still be valid.'}, 'valid': {'type': ['boolean', 'null'], 'description': 'True if the source confirms the number is registered and active.'}, 'source': {'type': ['string', 'null'], 'description': "Validation source, e.g. 'VIES' or 'CVR' (DK)."}, 'address': {'type': ['string', 'null'], 'description': 'Registered address. null when not disclosed by the member state.'}, 'vatNumber': {'type': ['string', 'null'], 'description': 'Full VAT number including country prefix, e.g. DE143454214.'}, 'countryCode': {'type': ['string', 'null'], 'description': 'Country code (uppercase).'}}, 'additionalProperties': True}