Samenwerkfunctionaliteit

Label: Samenwerken

Endpoints

Pre-productieomgeving

_{https://pkio.service.pre.omgevingswet.overheid.nl/overheid/samenwerken/api/behandelen/v5/}

Productieomgeving

_{https://pkio.service.omgevingswet.overheid.nl/overheid/samenwerken/api/behandelen/v5/}

Beveiligde REST-service

Vraag toegang aan voor deze beveiligde REST-service voor de pre-productieomgeving via dit formulier en voor de productieomgeving via dit formulier.

Omschrijving

Een globaal overzicht van de beschikbare services:

• Het starten van een samenwerking. Hierbij wordt een samenwerkdossier met bijbehorende identificatie gecreëerd en wordt (optioneel) een bijbehorend 'verzoek' (vergunningaanvraag) opgehaald uit de DSO-LV en in het digitale samenwerkdossier geplaatst. Een samenwerking kan alleen door een bevoegd gezag of behandeldienst worden gestart: de initiator van de samenwerking. Gegevens die te maken hebben met de samenwerking (metadata) kunnen worden toegevoegd, gewijzigd en ingezien.
• Het uitnodigen van ketenpartners om deel te nemen aan de samenwerking. Dit gebeurt op basis van het OIN (Organisatie-identificatienummer) van de ketenpartner; organisaties zonder OIN maar met inschrijving in het Handelsregister gebruiken het handelsregisternummer (HRN). Bij de uitnodiging krijgt de ketenpartner een privilege: 'Volledige toegang' (ook tot strikt vertrouwelijke documenten, die persoonsgegevens en/of bedrijfsgevoelige gegevens kunnen bevatten) of 'Beperkte toegang' (alleen tot vertrouwelijke documenten zonder zulke gegevens). Alleen de initiator kan ketenpartners uitnodigen, verwijderen en privileges aanpassen.
• Het opvragen van organisaties: welke organisaties zijn bekend, en of en wanneer zij voor het laatst gebruik hebben gemaakt van de SWF. Handig om vóór een uitnodiging te controleren of een beoogde ketenpartner de SWF daadwerkelijk gebruikt.
• Het vastleggen van een samenwerkingsverband: een organisatie kan een behandelorganisatie aanwijzen die namens haar deelneemt aan samenwerkingen. Wordt de organisatie uitgenodigd, dan wordt de behandelorganisatie de feitelijke deelnemer en is voor alle deelnemers zichtbaar namens wie deze optreedt.
• Het toevoegen, downloaden, actualiseren en verwijderen van documenten in het samenwerkdossier, met een vertrouwelijkheidskenmerk per document ('Strikt vertrouwelijk' of 'Vertrouwelijk') en een maximale omvang van 250 MB. De toegang volgt uit het privilege van de deelnemer; per document kunnen de rechten van een deelnemer afwijkend worden ingesteld. Ook kunnen alle toegankelijke documenten in één keer als zipbestand worden gedownload, bijvoorbeeld ten behoeve van archivering.
• Het uitzetten van actieverzoeken, bijvoorbeeld het verzoek om een brandveiligheidsadvies te geven aan een veiligheidsregio. Elke deelnemer kan een actieverzoek uitzetten bij elke andere deelnemer. De ontvanger kan het verzoek accepteren of weigeren en na uitvoering gereedmelden, waarna de zender het resultaat accordeert of het verzoek opnieuw in behandeling geeft. Actieverzoeken zijn inzichtelijk voor alle deelnemers, en er kunnen documenten uit het samenwerkdossier aan worden gekoppeld.
• Het versturen van berichten tussen zender en ontvanger van een actieverzoek (berichtenservice).
• Het ophalen van notificaties. De meeste gebeurtenissen die tijdens een samenwerking optreden (toevoegen document, statuswijziging van een actieverzoek, enzovoorts) leiden tot een notificatie aan de betrokkene(n). Deze notificaties kunnen door aangesloten systemen actief worden opgehaald en na verwerking worden verwijderd. Het formaat van notificaties is beschreven; zie 'beschrijving notificaties' onder het kopje documentatie.
• Het stoppen van een samenwerking. Als een samenwerking is afgerond kan de initiator deze sluiten; dit kan pas als er geen openstaande actieverzoeken meer zijn. Na sluiting kunnen geen documenten meer worden toegevoegd en geen actieverzoeken meer worden uitgezet; deelnemers kunnen nog wel documenten downloaden om aan hun archiveringsverplichtingen te voldoen, en de complete 'eventtrail' van de samenwerking ophalen ten behoeve van archivering. De initiator kan een gesloten samenwerking heropenen. Een samenwerking wordt ook automatisch gesloten als er zes maanden geen activiteit is geweest (de initiator wordt na vijf maanden inactiviteit genotificeerd).
• Het verwijderen van een samenwerking gebeurt automatisch, één maand na sluiting; alle deelnemers worden hiervan genotificeerd. Handmatig verwijderen is niet mogelijk. Een verwijderde samenwerking komt eerst twee weken in een 'prullenmand' terecht, waarin de initiator deze nog kan herstellen; daarna worden alle gegevens van het dossier (documenten, actieverzoeken en notificaties) definitief verwijderd.

Documentatie

• Procesbeschrijving (pdf, 610 kB) aansluiten
• 2026-08 SWF overzicht notificaties (pdf, 249 kB)
• 20260709-swf-v5-beschrijving-wijzigingen-v1-6 (pdf, 1.2 MB)

Aanvullende informatie

• De API is beschikbaar voor bevoegd gezagen en voor ketenpartners in de samenwerking, mits deze in het bezit zijn van een PKIO-certificaat.