Webservices
Via de Webservices hebben professionele gebruikers toegang tot gegevens van neergelegde jaarrekeningen. In totaal hebben ze de keuze tussen vijf soorten van Webservices. Bij de intekening vermeldt de gebruiker voor welk type Webservice hij of zij kiest.
Vijf types van Webservices
De vijf types van webservices zijn:
1. Query authentic data / Opvraging authentieke gegevens
Het product maakt het mogelijk om actuele en historische gegevens op te vragen op basis van het KBO-nummer van een specifieke rechtspersoon (onderneming) of het refertenummer van neerlegging.
2. Daily extract authentic data / Dagelijks extract authentieke gegevens
Het product maakt het mogelijk om voor een beperkte periode alle refertesgegevens en documenten van door de Nationale Bank aanvaarde en gepubliceerde neerleggingen van jaarrekeningen voor één specifieke dag te bekomen in de vorm van datasets (zip-bestanden).
3. Improved data / Verbeterde gegevens
Het product maakt het mogelijk om op dagbasis voor een beperkte periode alle door de Nationale Bank verbeterde informatie op te vragen in de vorm van datasets (zip-bestand). Het product maakt het ook mogelijk om de lijst van refertes van verbeterde neerleggingen per KBO-nummer op te vragen en de gekoppelde JSON-documenten te verkrijgen.
4. Authentic Archive Data / Historische authentieke gegevens
Het product maakt het mogelijk om op een opgegeven datum de refertes en documenten van door de Nationale Bank aanvaarde en gepubliceerde neerleggingen over de laatste drie jaar te verkrijgen.
5. Improved Archive Data / Historische verbeterde gegevens
Het product maakt het mogelijk om alle refertes en documenten van de neerleggingen waarin de Nationale Bank verbeteringen heeft aangebracht over de afgelopen drie jaar te verkrijgen.
Beperkingen
De Webservices kennen een aantal beperkingen:
- Gebruikers hebben alleen toegang tot refertes en documenten van neerleggingen die in aanmerking komen voor publicatie. Neerleggingen van aparte sociale balansen (van ondernemingen die geen jaarrekening moeten neerleggen), zijn dus niet beschikbaar via de Webservices.
- XBRL-documenten zijn pas later geïntroduceerd na PDF en zijn daardoor niet beschikbaar voor alle oudere neerleggingen.
- JSON-documenten op basis van XBRL-neerleggingen zijn op 4 april 2022 geïntroduceerd en zijn daardoor niet beschikbaar voor oudere neerleggingen.
- Het archief met JSON-bestanden voor ‘Authentic Data’ en ‘Improved Data’ wordt opgebouwd vanaf 4 april 2022 en zal pas op termijn de gegevens over de laatste 3 jaar bevatten.
Meer info
Meer info over de Webservices kan u nog vinden via:
- De abonnementsvoorwaarden
- De technische gids (enkel beschikbaar in het Engels)
- Een Powerpoint-presentatie
- De 'Webservices in testomgeving', waar u de producten kan verkennen. Voor 'Improved data' hebben we in de testomgeving een gratis dataset beschikbaar gesteld voor de maand december 2022.
Toegangsprocedure
Om toegang te krijgen tot de Webservices moeten nieuwe gebruikers een aantal stappen zetten:
- Een administratieve inschrijving: het invullen van een bestelbon of webformulier.
- Nieuwe gebruikers ontvangen een CLIENT_ID die ze moeten doorgeven aan de technische gebruiker.
- De technische gebruiker dient een profiel aan te maken op het developers portaal https://developer.cbso.nbb.be
- Na controle zal het Technisch Support Team van de Nationale Bank van België de aanvragen goedkeuren en de producten identificeren op basis van de administratieve registratie en de CLIENT_ID. De technische gebruiker zal de CLIENT_ID terugvinden in de abonnementsdetails. Voor betalende producten (Improved Data/Improved Archived Data) zal dit pas na ontvangst van de betaling gebeuren.
Technische en praktische documentatie
Technische documentatie
Hieronder vindt u nuttige documenten om de technische toegangen voor de Webservices te verkrijgen én om een clienttoepassing te configureren.
Een overzicht:
- Technical guide (EN): beschrijving van de procedure voor toegang tot de Webservices en de parameters die gebruikt moeten worden om te interageren met de Webservices
- Developer portal: portaal voor de gebruikers van de Webservices om technische sleutels voor toegang te verkrijgen en de beschrijving van Webservice bewerkingen (API) in verschillende formaten (openAPI, Swagger, etc.).
Portaal voor de testomgeving: https://developer.uat2.cbso.nbb.be/ - Technische beschrijving van gegevensweergaven teruggestuurd door bewerkingen/accountingData
- Codelijsten
Infografiek Webservices - situatie op 1 april 2023
