Burgergegevens raadplegen via webservice
Om burgergegevens te kunnen raadplegen vanuit uw eigen softwareomgeving, activeert u 2 webservicekanalen. De communicatie verloopt via de beveiligde API Gateway van de sociale zekerheid.
Met de REST API GrantCitizen vraagt u toegang tot de gegevens van een burger. Deze webservice communiceert met de Kruispuntbank van de Sociale Zekerheid en vormt de basis voor de opvraging van burgergegevens.
De REST API PrecontractualInformation communiceert met Sigedis. Met deze webservice raadpleegt u gegevens van een burger als u daarvoor toestemming gekregen hebt via GrantCitizen.
De technische informatie op deze pagina is bedoeld voor IT-diensten en softwareontwikkelaars.
Stappen voorafgaand aan de integratie van de REST-webservice
Zoals bij elke REST-API (Representational State Transfer API), moet u vóór de integratie van de REST-webservice in uw IT-systeem een aantal stappen doorlopen:
- Uw onderneming als werkgever identificeren en een Hoofdtoegangsbeheerder aanstellen
- Het REST-kanaal in Chaman configureren
- Een toegangstoken krijgen
- Het toegangstoken gebruiken voor de oproepen
Raadpleeg de REST Documentation-website (in het Engels) Nieuw venster voor technische informatie over deze stappen.
Functies van de REST-webservices
Om burgergegevens te raadplegen via webservice, moet u 2 kanalen openen in de onlinedienst Chaman (Channel Management):
- GrantCitizen: ‘Burgermandaten beheren’, waarmee uw onderneming burgers om een mandaat vraagt en die mandaten beheert, en
- PrecontractualInformation: ‘Burgergegevens raadplegen’, om burgergegevens op te vragen als een burger toegang gegeven heeft.
Belangrijk: zet een ‘Circle of Trust’ op
De webservices kunnen pas echt gebruikt worden als uw onderneming een ‘Circle of Trust’ opgezet heeft om de informatieveiligheid te garanderen. Het is de Hoofdtoegangsbeheerder van uw onderneming die de gebruiksvoorwaarden voor de webservice Nieuw venster moet aanvaarden.
Technische documentatie
- eGov3.0-Burgergegevens raadplegen – context – API v3 .pdf - Nieuw venster
- Handleiding GrantCitizen REST API (in het Engels) .pdf - Nieuw venster
- GrantCitizen API Documentation Nieuw venster
- Handleiding PrecontractualInformation REST API (in het Engels) .pdf - Nieuw venster
- PrecontractualInformation API Documentation Nieuw venster