How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VNG Realisatie Klantcontacten API

The Klantcontacten API from VNG Realisatie — 8 operation(s) for klantcontacten.

VNG Realisatie Klantcontacten API is one of 42 APIs that VNG Realisatie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 42 JSON Schema definitions.

Tagged areas include Klantcontacten. The published artifact set on APIs.io includes an OpenAPI specification and 42 JSON Schemas.

This API exposes 9 operations across 8 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00, https://www.voorbeeldgemeente.nl/api/klantinteracties/v00, https://zaken-api.vng.cloud/api/v1/.

9 operations 8 paths 49 schemas 2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://zaken-api.vng.cloud/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

VNG Realisatie Klantcontacten API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT-Claims).

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 2 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Klantcontacten 9
POST
/_registreer_binnenkomend_telefoongesprek
Registreerbinnekomendtelefoongesprek
registreerbinnekomendtelefoongesprek body → 200400401403409410415429
POST
/_registreer_keukentafelgesprek
Registreerkeukentafelgesprek
registreerkeukentafelgesprek body → 200400401403409410415429
POST
/_registreer_klantcontact
Registreerklantcontact
registreerklantcontact body → 200400401403409410415429
POST
/_registreer_klantcontact_gaat_over_interne_taak
Registreerklantcontactgaatoverinternetaak
registreerklantcontactgaatoverinternetaak body → 200400401403409410415429
POST
/_registreer_klantcontact_gaat_over_object
Registreerklantcontactgaatoverobject
registreerklantcontactgaatoverobject body → 200400401403409410415429
POST
/_verwijder_klantcontact_gaat_over
Verwijderklantcontactgaatover
verwijderklantcontactgaatover body → 200400401403409410415429
GET
/klantcontactendeprecated
Alle KLANTCONTACTen opvragen
klantcontact_list 2 params → 200400401403406409410415
POST
/klantcontactendeprecated
Maak een KLANTCONTACT bij een ZAAK aan
klantcontact_create 3 params body → 201400401403406409410415
GET
/klantcontacten/{uuid}deprecated
Een specifieke KLANTCONTACT opvragen
klantcontact_retrieve 1 param → 200401403404406409410415

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are Correspondentieadres (14 properties), ObjectVanKlantcontact (12 properties), Bezoekadres (12 properties), Klantcontact (11 properties). Each schema is shown below with its type and property counts.

Initiatiefnemer
string
De waarden van de partij die het contact heeft geinitieerd. gemeente - De gemeente heeft het contact geinitieerd. klant - De klant heeft het contact geinitieer…
Registreerklantcontact_parameters
object
9 properties 8 required
Naamlang
string
DigitaalAdres
object
Adres waarop een persoon of een organisatie via een digitaal kanaal bereikt kan worden. Digitaal adres duidt gegevens aan die beschrijven hoe een persoon of or…
6 properties 6 required
AanduidingBijHuisnummer
string
De aanduiding die gebruikt wordt voor bijvoorbeeld een ligplaats of een standplaats die geen eigen nummeraanduiding heeft.
BetrokkeneBijKlantcontact
object
De betrokkenheid en de rol van een persoon of organisatie bij het klantcontact. Klantcontact-betrokkene kent afhankelijk van mogelijkheid of wenselijkheid om i…
9 properties 3 required
Huisnummertoevoeging
string
Persoonsnaamgegevens
object
De naamgegevens van een persoon.
3 properties
SoortBezoekadres
string
Typering waarmee aangegeven of het bezoekadres een binnenlands - of een buitenlands adres is. binnenlandsadres - binnenlands adres buitenlandsadres - buitenlan…
ObjectVanKlantcontact
object
De relatie tussen het klantcontact en de Zaak, Klanttaak of ander object waar dit klantcontact betrekking op heeft.
12 properties 7 required
Inhoudsdeel
object
(Een deel van) de inhoud van een klantcontact. Deze inhoud kan bestaan uit stuk tekst dat in het element tekst is opgenomen of een verwijzing naar een object z…
7 properties 6 required
Bezoekadres
object
Een bezoekadres is een adres waar een persoon of een bedrijf bezoekers ontvangt.
12 properties 1 required
Identificerendnummer
integer
SoortDigitaalAdres
object
Een opsomming van de type digitaal adres waarlangs de gemeente klantcontacten kan hebben.
3 properties 3 required
IndicatieJaNeeOnbekend
string
Deze enumeratie is toegevoegd omdat de ingevulde waarde geen boolean kan zijn (waar of niet waar). De gewenste waarden zijn ja,nee of onbekend. onbekend - ja -…
Registreerkeukentafelgesprek_parameters
object
6 properties 5 required
Huisnummer
integer
Postbusnummer
integer
Correspondentieadres
object
Het adres waarnaar de persoon of de organisatie de voor hen bestemde correspondentie laat verzenden.
14 properties 1 required
SoortInhoudsdeel
string
De typering van het inhoudsdeel. informatieobject - informatieobject overigobject - overig object tekst - tekst
Postcode
string
Antwoordnummer
integer
Kanaal
object
Een opsomming van de kanalen waarlangs de gemeente klantcontacten kan hebben.
3 properties 3 required
Klantcontactrol
string
De typering van de rol van de persoon of organisatie in het klantcontact.
RegistreerKlantcontactGaatOverInterneTaak_parameters
object
2 properties 2 required
Omschrijvinglang
string
Inhoudsdeel_param
object
6 properties 5 required
Omschrijvingkort
string
Voorkeurstaal
object
Een opsomming van de talen waarin de gemeente klantcontacten kan hebben.
3 properties 3 required
Land
object
Een opsomming van alle huidige en voormalige landen met hun codes, namen en geldigheidstermijnen.
4 properties 4 required
SoortObject
object
Een opsomming van de soorten objecten waarmee een koppeling gelegd wordt vanuit het register klantinteracties.
3 properties 3 required
VerwijderKlantcontactGaatOver_parameters
object
1 property 1 required
SoortCorrespondentieadres
string
Typering waarmee aangegeven wordt of het correspondentieadres een binnenlands - of een buitenlands adres is danwel een postbusnummer of een antwoordnummer. pos…
Woonplaats
string
Klantcontact
object
Een contact tussen een klant of een vertegenwoordiger van een klant en de gemeente. Het klantcontact is bedoeld om inwoners of ondernemers die contact hebben g…
11 properties 10 required
Identificatiecode
string
Adresregel
string
Een generieke regel om adresgegevens in op te nemen.
Registreertelefoongesprek_parameters
object
5 properties 4 required
Straat
string
BetrokkeneBijKlantcontact_param
object
8 properties 2 required
Datumtijd
string
RegistreerKlantcontactGaatOverObject_parameters
object
5 properties 5 required
IndicatieJaNee
boolean
Huisletter
string
Fout
object
Formaat van HTTP 4xx en 5xx fouten.
6 properties 5 required
PaginatedKlantContactList
object
4 properties
ValidatieFout
object
Formaat van HTTP 4xx en 5xx fouten.
7 properties 6 required
KlantContact
object
8 properties 4 required
FieldValidationError
object
Formaat van validatiefouten.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vng-realisatie-klantcontacten-api-openapi.yml Raw ↑

Other APIs VNG Realisatie publishes across the network.

VNG Realisatie Applicaties API
VNG Realisatie Besluiten API
VNG Realisatie Besluitinformatieobjecten API
VNG Realisatie Besluittypen API
VNG Realisatie Bestandsdelen API
VNG Realisatie Catalogussen API
VNG Realisatie Digitale adressen API
VNG Realisatie Domains API
VNG Realisatie Eigenschappen API
VNG Realisatie Enkelvoudiginformatieobjecten API
VNG Realisatie Events API
VNG Realisatie Geautomatiseerde actoren API
Where this information came from

This is an independent, third-party profile of VNG Realisatie Klantcontacten API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.