{"openapi":"3.1.0","info":{"title":"AXITAM Public API","description":"Reference data (ISO, CLDR), Belgian enterprises, annual accounts and addresses, Peppol participants - built on community-maintained and official sources. See the data-sources API for each source's version and license. Beta.","version":"0.10.0"},"servers":[{"url":"/","description":"This server"}],"tags":[{"name":"KBO code lists","description":"Code lists of the KBO/BCE Open Data with their French and Dutch (sometimes German) descriptions: ActivityGroup, Classification, ContactType, EntityContact, JuridicalForm, JuridicalSituation, Language, Nace2003, Nace2008, Nace2025, Status, TypeOfAddress, TypeOfDenomination, TypeOfEnterprise."},{"name":"Belgian addresses","description":"Autocompletion of a Belgian address in three guided steps - municipality, street, house number - then the full address with its official BeSt identifier and its WGS84 position. Source: BeSt Address, the federal and regional address registers (BOSA, Brussels, Flanders, Wallonia), queried live; data licensed CC BY 4.0 by BOSA and the three regions, attribution required. Identifiers are the regional URIs BeSt publishes: pass them back exactly as received."},{"name":"Annual accounts","description":"Annual accounts deposited by Belgian enterprises at the Central Balance Sheet Office of the National Bank of Belgium (source: NBB CBSO web services). The deposits of the last three years are mirrored and refreshed daily; the complete history of an enterprise (since 1978) is fetched from the NBB once, on request. Documents are relayed from the NBB."},{"name":"Enterprises","description":"Belgian enterprises registered in the Crossroads Bank for Enterprises (source: KBO/BCE Open Data, updated daily), to fill in and check forms: names, juridical form, addresses, contacts, NACE-BEL activities, establishment units and branches."},{"name":"Establishment units","description":"Places where Belgian enterprises operate (source: KBO/BCE Open Data). The units of one enterprise are listed under /api/v1/bel/enterprises/{number}/establishments."}],"paths":{"/api/v1/bel/kbo-codes/{category}":{"get":{"tags":["KBO code lists"],"summary":"List the codes of one category","description":"Ordered by code.","operationId":"findCategory","parameters":[{"name":"category","in":"path","description":"Code category, case-sensitive","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{1,50}$"},"example":"JuridicalForm"}],"responses":{"200":{"description":"The category's codes","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KboCodeResponse"}}}}},"400":{"description":"Malformed category (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such category (code KBO_CODE_CATEGORY_NOT_FOUND); names are case-sensitive","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/establishments/{number}":{"get":{"tags":["Establishment units"],"summary":"Read one establishment unit","description":"Owning enterprise, names, address, contacts and activities.","operationId":"findByNumber","parameters":[{"name":"number","in":"path","description":"Establishment unit number, with or without dots (2.000.000.339, 2000000339)","required":true,"schema":{"type":"string"},"example":"2.000.000.339"}],"responses":{"200":{"description":"Establishment unit found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EstablishmentResponse"}}}},"400":{"description":"Not a well-formed establishment unit number (code INVALID_ESTABLISHMENT_NUMBER)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No establishment unit has this number (code ESTABLISHMENT_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises":{"get":{"tags":["Enterprises"],"summary":"Search enterprises by name","description":"Enterprises having a name (legal name, abbreviation or commercial name, any language) containing the text, accents and case ignored, most similar first - for autocompletion.","operationId":"searchByName","parameters":[{"name":"name","in":"query","description":"Text contained in the name, at least 3 characters","required":true,"schema":{"type":"string","maxLength":100,"minLength":0,"pattern":"^\\s*\\S.*\\S.*\\S.*$"},"example":"axitam"},{"name":"limit","in":"query","description":"Maximum number of enterprises returned","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":20,"minimum":1},"example":10}],"responses":{"200":{"description":"Matching enterprises, possibly none","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EnterpriseSearchResultResponse"}}}}},"400":{"description":"Name shorter than 3 characters or limit out of 1-20 (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises/{number}":{"get":{"tags":["Enterprises"],"summary":"Read one enterprise","description":"Status, juridical form, names, registered office, contacts and activities, plus the fields added by the modules deployed alongside (peppol: the Peppol registration looked up live, whose status says whether the lookup succeeded).","operationId":"findByNumber_1","parameters":[{"name":"number","in":"path","description":"Enterprise number, with or without dots, spaces or BE prefix (0420.254.973, 0420254973, 420254973, BE0420254973)","required":true,"schema":{"type":"string"},"example":"0420.254.973"}],"responses":{"200":{"description":"Enterprise found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnterpriseResponse"}}}},"400":{"description":"Not a well-formed enterprise number (code INVALID_ENTERPRISE_NUMBER)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No enterprise has this number (code ENTERPRISE_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises/{number}/validation":{"get":{"tags":["Enterprises"],"summary":"Validate an enterprise or VAT number","description":"Never an error for a bad value: tells whether it is well-formed (check digits), registered and active, and gives its normalized and VAT forms.","operationId":"validate","parameters":[{"name":"number","in":"path","description":"Any value typed as an enterprise or VAT number","required":true,"schema":{"type":"string","maxLength":30,"minLength":0},"example":"BE0420254973"}],"responses":{"200":{"description":"Result of the check","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnterpriseValidationResponse"}}}},"400":{"description":"Value longer than 30 characters (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises/{number}/peppol":{"get":{"tags":["Enterprises"],"summary":"Read the Peppol registration of an enterprise","description":"Whether the enterprise receives documents on the Peppol network: the participants registered in the Peppol Directory under its enterprise number (0208:number) or its VAT number (9925:BEnumber), with the document types they accept. Live lookup.","operationId":"findPeppolRegistration","parameters":[{"name":"number","in":"path","description":"Enterprise number, with or without dots, spaces or BE prefix","required":true,"schema":{"type":"string"},"example":"0420.254.973"}],"responses":{"200":{"description":"The lookup result, isRegistered false when no participant exists","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnterprisePeppolResponse"}}}},"400":{"description":"Not a well-formed enterprise number (code INVALID_ENTERPRISE_NUMBER)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"The Peppol Directory did not answer (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"The Peppol Directory rate limit is saturated, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises/{number}/establishments":{"get":{"tags":["Enterprises"],"summary":"List the establishment units of an enterprise","description":"Ordered by number, each with its names, address, contacts and activities.","operationId":"findEstablishments","parameters":[{"name":"number","in":"path","description":"Enterprise number, with or without dots, spaces or BE prefix (0420.254.973, 0420254973, 420254973, BE0420254973)","required":true,"schema":{"type":"string"},"example":"0403.449.823"}],"responses":{"200":{"description":"The enterprise's establishment units, possibly none","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EstablishmentResponse"}}}}},"400":{"description":"Not a well-formed enterprise number (code INVALID_ENTERPRISE_NUMBER)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No enterprise has this number (code ENTERPRISE_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises/{number}/branches":{"get":{"tags":["Enterprises"],"summary":"List the Belgian branches of a foreign enterprise","description":"Ordered by number, each with its names, address, contacts and activities.","operationId":"findBranches","parameters":[{"name":"number","in":"path","description":"Enterprise number, with or without dots, spaces or BE prefix (0420.254.973, 0420254973, 420254973, BE0420254973)","required":true,"schema":{"type":"string"},"example":"0257.883.408"}],"responses":{"200":{"description":"The enterprise's branches, possibly none","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BranchResponse"}}}}},"400":{"description":"Not a well-formed enterprise number (code INVALID_ENTERPRISE_NUMBER)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No enterprise has this number (code ENTERPRISE_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/enterprises/{number}/annual-accounts":{"get":{"tags":["Annual accounts"],"summary":"List the annual accounts of an enterprise","description":"Deposits known for the enterprise, newest first, answered from the mirror. With history=complete, the complete history is fetched from the NBB the first time (several seconds) and stored; later calls answer from the mirror, kept up to date daily.","operationId":"findByEnterprise","parameters":[{"name":"number","in":"path","description":"Enterprise number, with or without dots, spaces or BE prefix","required":true,"schema":{"type":"string"},"example":"0420.254.973"},{"name":"history","in":"query","description":"complete: fetch the complete history from the NBB if not done yet","required":false,"schema":{"type":"string","pattern":"^complete$"},"example":"complete"}],"responses":{"200":{"description":"Deposits, possibly none","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EnterpriseAnnualAccountsResponse"}}}},"400":{"description":"Not a well-formed enterprise number (code INVALID_ENTERPRISE_NUMBER) or history other than complete (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"The NBB did not answer the history request (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards the NBB in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/annual-accounts/{reference}":{"get":{"tags":["Annual accounts"],"summary":"Read one annual account deposit","description":"By its NBB reference; a deposit not mirrored yet is fetched from the NBB and stored.","operationId":"findByReference","parameters":[{"name":"reference","in":"path","description":"Deposit reference: year and eight digits","required":true,"schema":{"type":"string"},"example":"2025-00555958"}],"responses":{"200":{"description":"Deposit found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AnnualAccountResponse"}}}},"400":{"description":"Not a well-formed reference (code INVALID_ANNUAL_ACCOUNT_REFERENCE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No deposit has this reference (code ANNUAL_ACCOUNT_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"The NBB did not answer (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards the NBB in flight (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/annual-accounts/{reference}/{format}":{"get":{"tags":["Annual accounts"],"summary":"Download a document of an annual account deposit","description":"Relayed from the NBB: pdf for every deposit (the accounts as filed), xbrl and json only for deposits with structured data (json for deposits since April 2022).","operationId":"downloadDocument","parameters":[{"name":"reference","in":"path","description":"Deposit reference: year and eight digits","required":true,"schema":{"type":"string"},"example":"2025-00555958"},{"name":"format","in":"path","description":"pdf, xbrl or json","required":true,"schema":{"type":"string"},"example":"pdf"}],"responses":{"200":{"description":"The document","content":{"application/pdf":{},"application/xml":{},"application/json":{}}},"400":{"description":"Not a well-formed reference (code INVALID_ANNUAL_ACCOUNT_REFERENCE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The NBB has no such document for this deposit (code ANNUAL_ACCOUNT_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"The NBB did not answer (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards the NBB in flight (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/addresses":{"get":{"tags":["Belgian addresses"],"summary":"Read one address","description":"The full address behind a BeSt identifier, as returned by the house-number step: street, house and box numbers, postal code, municipality, WGS84 position and register status. The identifier is a query parameter because the regional URIs contain slashes and colons.","operationId":"findAddress","parameters":[{"name":"id","in":"query","description":"BeSt identifier of the address, exactly as received","required":true,"schema":{"type":"string","maxLength":300,"minLength":0,"pattern":"^\\S+$"},"example":"https://databrussels.be/id/address/210225/1"}],"responses":{"200":{"description":"Address found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BelgianAddressResponse"}}}},"400":{"description":"id missing or with a space (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"BeSt knows no address with this identifier, or no longer this version of it (code ADDRESS_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"BeSt Address did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards BeSt Address are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/addresses/streets":{"get":{"tags":["Belgian addresses"],"summary":"Autocomplete a street","description":"In one municipality, given by its postal code or by its NIS code (exactly one of the two), by a part of the street name in any language (case, accents, spaces, apostrophes and hyphens ignored). Streets whose name starts with the text come first, then the other matches, alphabetically. Only current street names are returned.","operationId":"findStreets","parameters":[{"name":"postCode","in":"query","description":"Postal code of the municipality (alternative to nisCode)","required":false,"schema":{"type":"string","pattern":"^[0-9]{4}$"},"example":1000},{"name":"nisCode","in":"query","description":"NIS code of the municipality (alternative to postCode)","required":false,"schema":{"type":"string","pattern":"^[0-9]{5}$"},"example":21004},{"name":"name","in":"query","description":"Part of the street name, at least 2 characters","required":true,"schema":{"type":"string","pattern":"^[\\p{L}0-9 '\\-.]{2,100}$"},"example":"loi"},{"name":"limit","in":"query","description":"Maximum number of streets returned","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":50,"minimum":1},"example":10}],"responses":{"200":{"description":"Matching streets, possibly none","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StreetResponse"}}}}},"400":{"description":"postCode not 4 digits, nisCode not 5 digits, name shorter than 2 characters or with a forbidden character (wildcards included), or limit out of 1-50 (code INVALID_REQUEST); both or none of postCode and nisCode (code INVALID_ARGUMENT)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"BeSt Address did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards BeSt Address are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/addresses/municipalities":{"get":{"tags":["Belgian addresses"],"summary":"Autocomplete a municipality","description":"By a postal code or the beginning of one (digits only), or by a part of the municipality name in any language (case, accents, spaces, apostrophes and hyphens ignored). Municipalities whose name starts with the text come first, then the other matches, alphabetically; each municipality once, whatever its number of postal codes.","operationId":"findMunicipalities","parameters":[{"name":"q","in":"query","description":"Postal code (or its first digits) or a part of the municipality name","required":true,"schema":{"type":"string","pattern":"^([0-9]{1,4}|[\\p{L}0-9 '\\-.]{2,100})$"},"example":"brux"},{"name":"limit","in":"query","description":"Maximum number of municipalities returned","required":false,"schema":{"type":"integer","format":"int32","default":10,"maximum":50,"minimum":1},"example":10}],"responses":{"200":{"description":"Matching municipalities, possibly none","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MunicipalityResponse"}}}}},"400":{"description":"q shorter than 2 characters (1 for a postal-code prefix), longer than 100, with a character outside letters, digits, spaces, apostrophes, hyphens and dots (wildcards included), or limit out of 1-50 (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"BeSt Address did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards BeSt Address are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/addresses/house-numbers":{"get":{"tags":["Belgian addresses"],"summary":"Autocomplete a house number","description":"Every current address of a street (houses and boxes) or those whose house number starts with the digits typed, in natural order (1, 1A, 2, 10), each house before its boxes.","operationId":"findHouseNumbers","parameters":[{"name":"streetId","in":"query","description":"BeSt identifier of the street, as returned by the street step","required":true,"schema":{"type":"string","maxLength":300,"minLength":0,"pattern":"^\\S+$"},"example":"https://databrussels.be/id/streetname/1679/1"},{"name":"houseNumber","in":"query","description":"Beginning of the house number; omitted, every address of the street","required":false,"schema":{"type":"string","pattern":"^[\\p{L}0-9\\-]{1,10}$"},"example":1},{"name":"limit","in":"query","description":"Maximum number of addresses returned","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":100,"minimum":1},"example":20}],"responses":{"200":{"description":"Matching addresses, possibly none","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HouseNumberResponse"}}}}},"400":{"description":"streetId missing or with a space, houseNumber not 1-10 letters, digits or hyphens, or limit out of 1-100 (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"BeSt Address did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Too many requests towards BeSt Address are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"correlationId":{"type":"string"}}},"KboCodeResponse":{"type":"object","description":"A value of a KBO code list, with its descriptions","properties":{"code":{"type":"string","description":"The code","example":"014"},"descriptions":{"type":"object","additionalProperties":{"type":"string"},"description":"Description by language (FR, NL, sometimes DE); empty for a code the KBO uses without listing it (contact type FAX)","example":{"FR":"Société anonyme","NL":"Naamloze vennootschap"}}}},"ActivityResponse":{"type":"object","description":"An economic activity (NACE-BEL), as registered for one purpose","properties":{"group":{"$ref":"#/components/schemas/KboCodeResponse","description":"What the activity is registered for (ActivityGroup): 001 VAT, 006 social security..."},"naceVersion":{"type":"string","description":"NACE-BEL version of the code","enum":["2003","2008","2025"],"example":"2025"},"nace":{"$ref":"#/components/schemas/KboCodeResponse","description":"The NACE-BEL code"},"classification":{"$ref":"#/components/schemas/KboCodeResponse","description":"MAIN, SECO (secondary) or ANCI (ancillary) (Classification)"}}},"AddressResponse":{"type":"object","description":"An address, in French and Dutch where they differ","properties":{"type":{"$ref":"#/components/schemas/KboCodeResponse","description":"Kind of address (TypeOfAddress): REGO registered office, BAET establishment unit, ABBR branch"},"countryFr":{"type":["string","null"],"description":"Country in French; absent for Belgium"},"countryNl":{"type":["string","null"],"description":"Country in Dutch; absent for Belgium"},"zipcode":{"type":["string","null"],"description":"Postal code","example":"1000"},"municipalityFr":{"type":["string","null"],"description":"Municipality in French","example":"Bruxelles"},"municipalityNl":{"type":["string","null"],"description":"Municipality in Dutch","example":"Brussel"},"streetFr":{"type":["string","null"],"description":"Street in French"},"streetNl":{"type":["string","null"],"description":"Street in Dutch"},"houseNumber":{"type":["string","null"],"description":"House number"},"box":{"type":["string","null"],"description":"Box number"},"extraInfo":{"type":["string","null"],"description":"Additional information"},"strikingOffDate":{"type":["string","null"],"format":"date","description":"Date the address was struck off"}}},"ContactResponse":{"type":"object","description":"A way to reach the entity, as published by the KBO","properties":{"type":{"$ref":"#/components/schemas/KboCodeResponse","description":"Kind of contact (ContactType): EMAIL, TEL, WEB, FAX"},"value":{"type":"string","description":"The address or number, as published"}}},"DenominationResponse":{"type":"object","description":"A name, in one language","properties":{"type":{"$ref":"#/components/schemas/KboCodeResponse","description":"Kind of name (TypeOfDenomination): 001 name, 002 abbreviation, 003 commercial name"},"language":{"$ref":"#/components/schemas/KboCodeResponse","description":"Language (KBO Language code: 1 French, 2 Dutch, 3 German, 4 English)"},"value":{"type":"string","description":"The name","example":"AXITAM"}}},"EstablishmentResponse":{"type":"object","description":"An establishment unit: a place where an enterprise operates","properties":{"establishmentNumber":{"type":"string","description":"Establishment unit number, published form","example":"2.000.000.339"},"enterpriseNumber":{"type":"string","description":"Owning enterprise number","example":"0403.449.823"},"startDate":{"type":"string","format":"date","description":"Start date"},"denominations":{"type":"array","description":"Names of the unit","items":{"$ref":"#/components/schemas/DenominationResponse"}},"addresses":{"type":"array","description":"Address of the unit","items":{"$ref":"#/components/schemas/AddressResponse"}},"contacts":{"type":"array","description":"Contacts of the unit","items":{"$ref":"#/components/schemas/ContactResponse"}},"activities":{"type":"array","description":"Activities of the unit","items":{"$ref":"#/components/schemas/ActivityResponse"}}}},"EnterpriseSearchResultResponse":{"type":"object","description":"An enterprise whose name contains the searched text","properties":{"enterpriseNumber":{"type":"string","description":"Enterprise number, published form","example":"0420.254.973"},"name":{"type":"string","description":"The enterprise's name most similar to the searched text","example":"AXITAM"},"typeOfEnterprise":{"$ref":"#/components/schemas/KboCodeResponse","description":"Type of enterprise: 1 natural person, 2 legal person"},"juridicalForm":{"type":"null","$ref":"#/components/schemas/KboCodeResponse","description":"Juridical form; absent for natural persons"},"zipcode":{"type":["string","null"],"description":"Postal code of the registered office"},"municipalityFr":{"type":["string","null"],"description":"Municipality of the registered office in French"},"municipalityNl":{"type":["string","null"],"description":"Municipality of the registered office in Dutch"}}},"EnterpriseResponse":{"type":"object","description":"A registered Belgian enterprise (source: KBO/BCE Open Data)","properties":{"enterpriseNumber":{"type":"string","description":"Enterprise number, published form","example":"0420.254.973"},"vatNumber":{"type":"string","description":"VAT number built on the enterprise number","example":"BE0420254973"},"status":{"$ref":"#/components/schemas/KboCodeResponse","description":"Status (AC active - the KBO extracts only publish active enterprises)"},"juridicalSituation":{"$ref":"#/components/schemas/KboCodeResponse","description":"Juridical situation (JuridicalSituation): 000 normal situation..."},"typeOfEnterprise":{"$ref":"#/components/schemas/KboCodeResponse","description":"Type of enterprise (TypeOfEnterprise): 1 natural person, 2 legal person"},"juridicalForm":{"type":"null","$ref":"#/components/schemas/KboCodeResponse","description":"Juridical form (JuridicalForm); absent for natural persons"},"juridicalFormCac":{"type":"null","$ref":"#/components/schemas/KboCodeResponse","description":"Juridical form under the Code of companies and associations, when it differs"},"startDate":{"type":"string","format":"date","description":"Start date"},"denominations":{"type":"array","description":"Names of the enterprise","items":{"$ref":"#/components/schemas/DenominationResponse"}},"addresses":{"type":"array","description":"Addresses of the enterprise (registered office)","items":{"$ref":"#/components/schemas/AddressResponse"}},"contacts":{"type":"array","description":"Contacts of the enterprise","items":{"$ref":"#/components/schemas/ContactResponse"}},"activities":{"type":"array","description":"Activities of the enterprise, newest NACE version and main activities first","items":{"$ref":"#/components/schemas/ActivityResponse"}},"extensions":{"type":["object","null"],"additionalProperties":{},"description":"Fields added by the modules deployed alongside, serialized at the record's top level: peppol (Peppol registration, when the Belgian composition module is present)"}}},"EnterpriseValidationResponse":{"type":"object","description":"The check of a value typed as a Belgian enterprise or VAT number","properties":{"input":{"type":"string","description":"The value as received","example":"BE 0420.254.973"},"normalized":{"type":["string","null"],"description":"Published form; absent when not well-formed","example":"0420.254.973"},"vatNumber":{"type":["string","null"],"description":"VAT number built on it; absent when not well-formed","example":"BE0420254973"},"isWellFormed":{"type":"boolean","description":"10 digits starting with 0 or 1 and right check digits (modulo 97)"},"isRegistered":{"type":"boolean","description":"An enterprise with this number is in the loaded KBO extract"},"isActive":{"type":"boolean","description":"That enterprise is active"}}},"EnterprisePeppolResponse":{"type":"object","description":"Whether the enterprise receives documents on the Peppol network (source: Peppol Directory, looked up live under the enterprise number, agency 0208, and the VAT number, agency 9925)","properties":{"enterpriseNumber":{"type":"string","description":"Enterprise number, published form","example":"0420.254.973"},"vatNumber":{"type":"string","description":"VAT number built on it","example":"BE0420254973"},"status":{"type":"string","description":"Outcome of the Directory lookup: OK, or why the registration is unknown (UPSTREAM_UNAVAILABLE, UPSTREAM_BUSY - retry later)","enum":["OK","UPSTREAM_UNAVAILABLE","UPSTREAM_BUSY"]},"isRegistered":{"type":["boolean","null"],"description":"At least one participant is registered; absent when the lookup failed"},"participants":{"type":"array","description":"Participants registered under the enterprise or VAT number, possibly none","items":{"$ref":"#/components/schemas/PeppolParticipantResponse"}}}},"PeppolBusinessEntityResponse":{"type":"object","description":"A business entity registered behind the participant identifier","properties":{"names":{"type":"array","description":"Names, possibly in several languages","items":{"$ref":"#/components/schemas/PeppolEntityNameResponse"}},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"BE"},"geoInfo":{"type":["string","null"],"description":"Free-text geographical information"},"identifiers":{"type":"array","description":"Additional identifiers","items":{"$ref":"#/components/schemas/PeppolIdentifierResponse"}},"websites":{"type":"array","description":"Websites","items":{"type":"string"}},"contacts":{"type":"array","description":"Contacts, as published","items":{"$ref":"#/components/schemas/PeppolContactResponse"}},"additionalInfo":{"type":["string","null"],"description":"Free-text additional information"},"registrationDate":{"type":["string","null"],"format":"date","description":"Date the business card was registered","example":"2025-04-04"}}},"PeppolContactResponse":{"type":"object","description":"A contact published on the business card, as published","properties":{"type":{"type":["string","null"],"description":"Purpose of the contact","example":"support"},"name":{"type":["string","null"],"description":"Contact name"},"phone":{"type":["string","null"],"description":"Phone number"},"email":{"type":["string","null"],"description":"E-mail address"}}},"PeppolDocumentTypeResponse":{"type":"object","description":"A document type the participant can receive","properties":{"scheme":{"type":"string","description":"Document type identifier scheme","example":"busdox-docid-qns"},"value":{"type":"string","description":"Document type identifier","example":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"}}},"PeppolEntityNameResponse":{"type":"object","description":"A name of the business entity, optionally in a given language","properties":{"name":{"type":"string","description":"The name","example":"AXITAM"},"language":{"type":["string","null"],"description":"ISO 639-1 language code; absent when the Directory gives none","example":"fr"}}},"PeppolIdentifierResponse":{"type":"object","description":"An identifier with its scheme","properties":{"scheme":{"type":"string","description":"Identifier scheme","example":"GLN"},"value":{"type":"string","description":"Identifier value","example":"5410000000001"}}},"PeppolParticipantResponse":{"type":"object","description":"A Peppol participant: its identifier, the business entities behind it and the document types it receives (source: Peppol Directory, live)","properties":{"participantId":{"$ref":"#/components/schemas/PeppolIdentifierResponse","description":"Participant identifier: ISO 6523 issuing agency code and identifier (0208 = Belgian enterprise number, 9925 = Belgian VAT number, 0009 = French SIRET...)"},"entities":{"type":"array","description":"Business entities registered behind the identifier","items":{"$ref":"#/components/schemas/PeppolBusinessEntityResponse"}},"documentTypes":{"type":"array","description":"Document types the participant can receive","items":{"$ref":"#/components/schemas/PeppolDocumentTypeResponse"}}}},"BranchResponse":{"type":"object","description":"A Belgian branch of a foreign company","properties":{"branchNumber":{"type":"string","description":"Branch number, published form","example":"9.000.006.626"},"enterpriseNumber":{"type":"string","description":"Owning enterprise number","example":"0257.883.408"},"startDate":{"type":"string","format":"date","description":"Start date"},"denominations":{"type":"array","description":"Names of the branch","items":{"$ref":"#/components/schemas/DenominationResponse"}},"addresses":{"type":"array","description":"Address of the branch","items":{"$ref":"#/components/schemas/AddressResponse"}},"contacts":{"type":"array","description":"Contacts of the branch","items":{"$ref":"#/components/schemas/ContactResponse"}},"activities":{"type":"array","description":"Activities of the branch","items":{"$ref":"#/components/schemas/ActivityResponse"}}}},"AnnualAccountAddressResponse":{"type":"object","description":"The registered office as stated on the deposit","properties":{"street":{"type":["string","null"],"description":"Street","example":"Rue de la Centenaire(ET)"},"houseNumber":{"type":["string","null"],"description":"House number","example":"126"},"box":{"type":["string","null"],"description":"Box number"},"postalCode":{"type":["string","null"],"description":"Postal code","example":"7050"},"city":{"type":["string","null"],"description":"City","example":"Jurbise"},"countryCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code","example":"BE"}}},"AnnualAccountDocumentsResponse":{"type":"object","description":"Where this API relays the documents of the deposit from the NBB","properties":{"pdf":{"type":"string","description":"The accounts as filed, PDF (every deposit)","example":"/api/v1/bel/annual-accounts/2025-00555958/pdf"},"xbrl":{"type":["string","null"],"description":"The XBRL instance; absent when the deposit has no structured data","example":"/api/v1/bel/annual-accounts/2025-00555958/xbrl"},"json":{"type":["string","null"],"description":"The NBB's JSON rendering of the XBRL (deposits since April 2022); absent when the deposit has no structured data","example":"/api/v1/bel/annual-accounts/2025-00555958/json"}}},"AnnualAccountResponse":{"type":"object","description":"An annual account deposit at the Belgian Central Balance Sheet Office (NBB)","properties":{"referenceNumber":{"type":"string","description":"Reference the NBB assigned to the deposit","example":"2025-00555958"},"enterpriseNumber":{"type":"string","description":"Enterprise number, 10 digits","example":"0420254973"},"depositDate":{"type":"string","format":"date","description":"Date of the deposit","example":"2025-10-31"},"exerciseStart":{"type":["string","null"],"format":"date","description":"First day of the financial year","example":"2024-01-01"},"exerciseEnd":{"type":["string","null"],"format":"date","description":"Last day of the financial year","example":"2024-12-31"},"modelType":{"type":["string","null"],"description":"NBB model of the accounts (m02-f full model, m81-f micro model, m87-f micro model...)","example":"m87-f"},"depositType":{"type":["string","null"],"description":"Initial, Correction or Complementary","example":"Initial"},"language":{"type":["string","null"],"description":"Language of the deposit: FR, NL, DE or EN","example":"FR"},"currency":{"type":["string","null"],"description":"ISO 4217 currency of the accounts","example":"EUR"},"enterpriseName":{"type":["string","null"],"description":"Enterprise name as stated on the deposit","example":"AXITAM"},"address":{"type":"null","$ref":"#/components/schemas/AnnualAccountAddressResponse"},"legalForm":{"type":["string","null"],"description":"KBO juridical form code","example":"610"},"legalSituation":{"type":["string","null"],"description":"KBO juridical situation code","example":"000"},"legalValidation":{"type":["boolean","null"],"description":"Whether the deposit fulfilled the legal validation checks"},"activityCode":{"type":["string","null"],"description":"NACE-BEL main activity code","example":"63110"},"generalAssemblyDate":{"type":["string","null"],"format":"date","description":"Date of the general assembly that approved the accounts","example":"2025-10-23"},"structuredDataAvailable":{"type":"boolean","description":"The NBB holds structured data (XBRL, JSON) for this deposit, not only the PDF"},"dataVersion":{"type":["string","null"],"description":"Authentic (as filed) or Improved","example":"Authentic"},"documents":{"$ref":"#/components/schemas/AnnualAccountDocumentsResponse"}}},"EnterpriseAnnualAccountsResponse":{"type":"object","description":"The annual account deposits of a Belgian enterprise, newest first","properties":{"enterpriseNumber":{"type":"string","description":"Enterprise number, 10 digits","example":"0420254973"},"historyComplete":{"type":"boolean","description":"The complete history (every deposit since 1978) was fetched from the NBB; otherwise only the deposits of the mirrored period (3 years, kept up to date daily) are listed. Ask for history=complete to fetch it once."},"historyFetchedAt":{"type":["string","null"],"format":"date-time","description":"When the complete history was fetched"},"annualAccounts":{"type":"array","description":"Deposits, newest first","items":{"$ref":"#/components/schemas/AnnualAccountResponse"}}}},"BelgianAddressResponse":{"type":"object","description":"A Belgian address as the BeSt Address registers publish it","properties":{"addressId":{"type":"string","description":"BeSt identifier of the address (a regional URI, versioned: a new version of the address gets a new identifier and the old one answers 404)","example":"https://databrussels.be/id/address/210225/1"},"street":{"$ref":"#/components/schemas/StreetResponse","description":"Street name (its municipality is the one below)"},"houseNumber":{"type":"string","description":"House number, possibly with a letter","example":"16"},"boxNumber":{"type":["string","null"],"description":"Box number, null for the house itself"},"postCode":{"type":"string","description":"Postal code","example":"1000"},"municipality":{"$ref":"#/components/schemas/MunicipalityResponse","description":"Municipality"},"position":{"type":"null","$ref":"#/components/schemas/GeoPositionResponse","description":"WGS84 position, null when the register publishes none (about 120 000 Walloon addresses)"},"status":{"type":"string","description":"Status in the register","example":"current"},"isOfficiallyAssigned":{"type":["boolean","null"],"description":"Whether the address was officially assigned by the municipality, null when the register does not say","example":true}}},"GeoPositionResponse":{"type":"object","description":"WGS84 position in decimal degrees","properties":{"latitude":{"type":"number","description":"Latitude (north)","example":50.846169319921074},"longitude":{"type":"number","description":"Longitude (east)","example":4.366537635141211}}},"LocalizedNameResponse":{"type":"object","description":"A name in the languages the regional register provides (Brussels: nl and fr, Flanders: nl, Wallonia: fr, the German-speaking municipalities: fr, de and nl); an absent language is null","properties":{"nl":{"type":["string","null"],"description":"Dutch name","example":"Wetstraat"},"fr":{"type":["string","null"],"description":"French name","example":"Rue de la Loi"},"de":{"type":["string","null"],"description":"German name"}}},"MunicipalityResponse":{"type":"object","description":"A Belgian municipality as the BeSt Address registers publish it","properties":{"municipalityId":{"type":"string","description":"BeSt identifier of the municipality (a regional URI, to pass back as is)","example":"https://databrussels.be/id/municipality/21004/7"},"nisCode":{"type":"string","description":"NIS code of the municipality","example":"21004"},"name":{"$ref":"#/components/schemas/LocalizedNameResponse","description":"Name of the municipality"}}},"StreetResponse":{"type":"object","description":"A street name as the BeSt Address registers publish it","properties":{"streetId":{"type":"string","description":"BeSt identifier of the street (a regional URI, to pass back as is to the house-number step)","example":"https://databrussels.be/id/streetname/1679/1"},"name":{"$ref":"#/components/schemas/LocalizedNameResponse","description":"Name of the street"},"municipality":{"type":"null","$ref":"#/components/schemas/MunicipalityResponse","description":"Municipality assigning the name; null inside an address, whose municipality is given at address level"}}},"HouseNumberResponse":{"type":"object","description":"One address of a street: a house, or a box of a house","properties":{"addressId":{"type":"string","description":"BeSt identifier of the address (a regional URI, to pass back as is to read the full address)","example":"https://databrussels.be/id/address/210225/1"},"houseNumber":{"type":"string","description":"House number, possibly with a letter","example":"16"},"boxNumber":{"type":["string","null"],"description":"Box number, null for the house itself","example":"b003"}}}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Optional. A key of a registered developer (portal: /account/) raises the request rate of the client from the anonymous per-IP limit to the plan's. Without it the request is anonymous; an unknown or revoked key is refused (401 INVALID_API_KEY).","name":"X-API-Key","in":"header"}}}}