Verzoek indienen

Een REST API waarmee een verzoek (vergunningaanvraag, melding, informatieplicht, etc.) van buiten het Omgevingsloket kan worden ingediend.

Label: Vergunningcheck en indienen

Endpoint Pre-productieomgeving

https://service.pre.omgevingswet.overheid.nl/publiek/verzoeken/api/indienen/v4/

Endpoint Productieomgeving

https://service.omgevingswet.overheid.nl/publiek/verzoeken/api/indienen/v4/

Omschrijving

Met de Verzoek Indienen API kan in een aantal stappen een verzoek ingediend worden. Deze stappen worden hieronder beschreven. Voor elke stap is een aparte service beschikbaar. Niet alle stappen zijn verplicht.

Eerste stap

De eerste stap in het proces bestaat uit het initiëren van het indienproces waarbij gelijk het grootste deel van de beschrijving van het verzoek wordt meegegeven. Dit is een verplichte stap. Het resultaat van de aanroep van de bij deze stap behorende service bevat een link naar het verzoek én een link voor het toevoegen van documenten. Ook wordt een (tijdelijke) verzoekidentificatie in het resultaat mee teruggegeven.

Met het verzoek wordt een payload meegestuurd. Deze payload van de service bestaat uit een 'indienbericht'. Een indienbericht bestaat uit de volgende onderdelen:

  • algemene gegevens, waaronder het verzoektype (bijvoorbeeld 'Aanvraag vergunning'), het doel van het verzoek (bijvoorbeeld 'Vooroverleg'), etc.
  • bevoegd gezag. OIN én naam van het bevoegd gezag aan wie het verzoek is gericht.
  • activiteit(en). Dit betreft de juridische activiteiten waarop het indienbericht betrekking heeft.
  • locatie, zowel bronlocatie als geometrie in RD-formaat. Dit betreft de locatie waar de in het indienbericht genoemde activiteit(en) worden uitgevoerd.
  • een lijst met vragen die een algemeen karakter hebben, bijvoorbeeld gegevens over de aanvrager en/of diens gemachtigde.
  • een lijst met specifieke vragen die betrekking hebben op de in het indienbericht genoemde activiteit(en).

Hoewel het indienbericht geen deel uitmaakt van de STAM-standaard kan deze standaard wel worden gebruikt om meer inzicht te geven in de specifieke betekenis van de verschillende onderdelen van het indienbericht.

De service valideert de onderdelen van het indienbericht met behulp van de service Indieningsvereisten bepalen (onderdeel van de API 'Uitvoeren services'): als niet aan de indieningsvereisten wordt voldaan, dan is het indienbericht niet valide. Deze service is bedoeld om de actuele en correcte vragenlijsten op te halen. Om deze reden is het gebruik van deze service ook voor de afnemers van 'Verzoek Indienen' onmisbaar.

Toevoegen

In deze (optionele) stap kunnen documenten (bijlagen) worden toegevoegd aan het verzoek. Documenten worden gescand op virussen, en gecontroleerd op omvang en toegestane formaten.

Indienen

De indiening van het verzoek en eventueel toegevoegde documenten wordt in deze staf afgerond. De service retourneert onder meer het 'verzoeknummer', waaronder het verzoek wordt doorgegeven naar het bevoegd gezag. Het is de laatste, (verplichte) stap in het proces van indienen. Als deze stap niet wordt uitgevoerd binnen 24 uur nadat het indienproces is geïnitieerd, dan wordt de indiening afgebroken en is er (dus) geen verzoek ingediend.

Ophalen

Door het (nog niet volledig ingediende) verzoek op te halen krijgt men het verzoek en (nogmaals) de link voor het toevoegen van documenten.

Verwijderen

Hiermee verwijdert men het (deels) ingediende verzoek, dus voordat de indiening werd afgerond. Dit is bedoeld om het hele proces tussentijds af te breken. Een eenmaal ingediend verzoek kan niet meer via deze weg worden verwijderd. Een ingediend verzoek kan alleen nog worden ingetrokken, zie de volgende kop.

Aanvullen en intrekken

Naast ingediend kan een verzoek ook worden aangevuld of ingetrokken. Voor het intrekken van een verzoek dient alleen de eerder benoemde 'eerste stap' en de stap 'indienen' te worden gevolgd. Via aanvullen kunnen aan een ingediend verzoek nieuwe of gewijzigde antwoorden worden toegevoegd en/of bestaande verwijderd. Ook kunnen bijlagen worden verwijderd en/of toegevoegd. Een aanvulling moet altijd een compleet verzoek zijn en vervangt de voorgaande versie van het verzoek. Op deze manier kan ook worden doorgegeven dat bestaande informatie uit het oorspronkelijke verzoek niet meer relevant is.

Met intrekken wordt het gehele ingediende verzoek verwijderd, waarna het bevoegde gezag de verdere behandeling van het verzoek zal stoppen.

Aanvullende informatie

De API kan afgenomen worden met 'access tokens', die verkregen kunnen worden na authenticatie van de initiatiefnemer (of gemachtigde) van het in te dienen verzoek op de DSO identity server. Die authenticatie wordt gedaan op de DSO Identity Server middels OpenIDConnect 2.0 (Authorisation Code Flow). Hiervoor zijn enkele voorwaarden:

  • De applicaties moeten geregistreerd zijn bij de DSO identity server
  • Ze moeten voldoen aan de aansluitcriteria
  • En ze hebben de acceptatietest doorstaan

Waarom een nieuwe versie

De verzoek indienen service heeft in versie V2 een punt in het ontwerp zitten wat ambigue is, namelijk de situatie hoe wordt omgegaan met het niet meesturen van een antwoord op een vraag die een vooraf ingevuld antwoord heeft.

We weten dan niet wat de intentie van de toepassing is:

  • Er wordt geen antwoord meegestuurd omdat men geen antwoord op de vraag wil geven.
  • Er wordt geen antwoord meegestuurd omdat men het vooraf ingevulde antwoord correct vindt.

Dit wordt opgelost in V3 van de API Verzoek indienen. Met V3 wordt het verplicht om bij een vraag met een vooraf ingevuld antwoord altijd een antwoord mee te sturen. Dat mag dan een leeg antwoord zijn, het vooraf ingevulde antwoord of een ander antwoord. Door de verplichting een antwoord mee te geven is het ook zeker dat een leeg antwoord ook betekent dat de gebruiker geen antwoord heeft willen geven op de vraag.

Verzoek indienen V2 gaat er vanuit dat bij een leeg antwoord de gebruiker ook geen antwoord wil geven.

Standaarden


Status

Versie 4 beschikbaar in de pre-productie- en productieomgeving.

V3 is beschikbaar tot medio oktober 2024

V2 is beschikbaar tot 14 maart 2024 in pre-productie en tot 22 maart 2024 in de productieomgeving.

API specificaties

Meer informatie

Deze service is van belang bij het ontwikkelen van een vergunningcheck.

Authenticatie

De API kan afgenomen worden met 'access tokens', die verkregen kunnen worden na authenticatie van de initiatiefnemer (of gemachtigde) van het in te dienen verzoek op de DSO identity server. Die authenticatie wordt gedaan op de DSO Identity Server middels OpenIDConnect 2.0 (Authorisation Code Flow). Hiervoor zijn enkele voorwaarden: de applicaties moeten geregistreerd zijn bij de DSO identity server, ze moeten voldoen aan de aansluitcriteria en ze hebben de acceptatietest doorstaan.

Feedback

Geef feedback op deze service. Ga naar het forum om bevindingen te delen.