Profieldata van burgers afnemen met de Profiel API

Met de Profiel API haal je automatisch profieldata van burgers op bij VDAB om ze op te laden in je eigen systeem.

• Je mag de Profiel API gebruiken, nadat VDAB een partnership met jou heeft goedgekeurd en na het ondertekenen van een samenwerkingsovereenkomst.
• Je mag de Profiel API enkel voor professionele doeleinden gebruiken.
• De data-uitwisseling via de API moet een toegevoegde waarde hebben voor VDAB en voor je organisatie.

Lees hoe je toegang krijgt tot de Profiel API en welke stappen je moet doorlopen bij de technische voorbereiding met uitgebreide testfase op de pagina 'Hoe verloopt de voorbereiding (onboarding) als je wil starten met API's?'

Vraag de API aan

Met de Profiel API* kun je:

• profielen van burgers ophalen
• interactief zoeken naar profielen
• alle details van één specifiek profiel opvragen
• profielen synchroniseren in bulk

*Let op! Het gaat hier steeds uitsluitend om gegevens die de burger zelf actief heeft gedeeld.

Deze functionaliteiten zijn beschikbaar via de 4 endpoints van de Profiel API:

• GET /profielen/initial
  Het aanroepen van dit endpoint geeft een lijst van actieve profielen terug vanaf een bepaalde datum.
• GET /profielen (interactief zoeken)
  Bij het aanroepen van dit endpoint stel je verschillende selectiefilters in om een gewenste set aan profielen te bekomen.
• GET /profielen/{id}
  Het aanroepen van dit endpoint geeft de details van één specifiek profiel terug.
• GET /profielen/bulk
  Het aanroepen van dit endpoint geeft een lijst van profielen terug die geactiveerd, gewijzigd of verwijderd  zijn in de gevraagde tijdspanne. 

Paginering

Om het aantal resultaten per call te beperken gebruiken we paginering zowel voor het 'initieel ophalen', het 'interactief zoeken' als het 'in bulk synchroniseren'.

Voor een optimale werking  is het aan te raden de Profiel API te combineren met

• de Referentie API
• de Competent 2 API

Referentie API

Deze API heb je nodig voor de vertaling van de codes die gebruikt worden binnen de Profiel API.

Belangrijk

Voor de vertaling van studiecodes gebruik je subproduct 'Diploma’s'.

Let op! Er komen zowel nieuwe als oude studiecodes door in het subproduct. Gebruik de nieuwe codes. Dit zijn vooral numerieke codes (6 cijfers), op enkele uitzonderingen na.

Meer over de Referentie API

Competent 2 API

Voor de vertalingen van de codes van de Competent 2.0-standaard zoals 'beroep' en 'competenties', gebruik je de Competent 2 API(en niet de Referentie API).

Let op! De onderdelen staan in het Competent 2-product in het Engels vermeld.

Meer over de Competent 2 API 

VDAB gebruikt de API-sleutel (een unieke lange cijfercode) als authenticatiemiddel.

Extra beveiliging is voorzien via OAuth 2.0 (OIDC-protocol). 

De API's kunnen enkel benaderd worden via HTTPS-verbindingen die versleuteld zijn via TLS1.2 (of hoger) om de veiligheid te garanderen.

Voorlopig biedt VDAB nog geen aparte testomgeving voor deze API en kan je enkel rechtstreeks op de live-omgeving testen vanuit je eigen systeem.

We geven hieronder een voorbeeld van een mogelijke zoekopdracht:

Voorbeeld juni 2025: 

Zoek Masters economie en toegepaste economie  in de regio Aalst.

Stap 1: Aanvraag via GET /profielen

Criteria: 

• studies=800303 (Master economie en toegepaste economie)
• gewensteRegios=BE231A (regio Aalst)

Deze criteria kan je opvragen via de Referentie API - subproducten ‘diploma's’ en ‘locatie’.

Resultaat 20-06-2025:

• Bestand

  Profiel API - code voorbeeld 1 - juni 2025 (61.41 KB)

Stap 2: Individuele profielen opvragen via GET /profielen/{id}

We vragen de details van het voorlaatste dossier op.

Resultaat 20-06-2025:

• Bestand

  Profiel API - code voorbeeld 2 - juni 2025 (187.91 KB)