# info.description
De 'Verzoeken-API' slaat ingediende formuliergegevens op als gestructureerde JSON.Aangezien formulieren elk type veld kunnen bevatten, definieert elk formulier een JSON-schema dat de verwachte structuur specificeert.Inkomende gegevens worden getoetst aan dit schema en opgeslagen in een consistent, gestructureerd formaat.

**URN Pattern**

Open VTB uses URNs (Uniform Resource Names) to link to other resources, below is a description of the pattern that should be used.

**Syntax:**

`urn:<NID>:<NSS>[#<f-component>]`

**Parts:**

- `urn:` (required): fixed prefix for all URNs, every URN must start with this prefix.
- `NID` (required): Namespace Identifier: alphanumeric characters, e.g. `nld`.
- `NSS` (required): Namespace Specific String identifying the object, e.g. `brp:bsn:111222333`.
- `f-component` (optional): Optional component preceded by `#`, e.g. `#section1`.

**Examples:**

`urn:namespace:component:resource:uuid`, `urn:example:foo#bar`

For more information, see the official specification: https://datatracker.ietf.org/doc/html/rfc8141

# paths./verzoeken.get.parameters[].description
Een pagina binnen de gepagineerde set resultaten.

# paths./verzoeken.get.parameters[].description
Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500).

# paths./verzoeken.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoeken.post.responses.201.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoeken/{uuid}.get.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het Verzoek.

# paths./verzoeken/{uuid}.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoeken/{uuid}.put.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het Verzoek.

# paths./verzoeken/{uuid}.put.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoeken/{uuid}.patch.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het Verzoek.

# paths./verzoeken/{uuid}.patch.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoeken/{uuid}.delete.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het Verzoek.

# paths./verzoeken/{uuid}.delete.responses.204.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen.get.parameters[].description
Een pagina binnen de gepagineerde set resultaten.

# paths./verzoektypen.get.parameters[].description
Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500).

# paths./verzoektypen.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen.post.responses.201.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{uuid}.get.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het VerzoekType

# paths./verzoektypen/{uuid}.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{uuid}.put.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het VerzoekType

# paths./verzoektypen/{uuid}.put.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{uuid}.patch.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het VerzoekType

# paths./verzoektypen/{uuid}.patch.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{uuid}.delete.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het VerzoekType

# paths./verzoektypen/{uuid}.delete.responses.204.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{verzoektypeUuid}/versies.get.parameters[].description
Een pagina binnen de gepagineerde set resultaten.

# paths./verzoektypen/{verzoektypeUuid}/versies.get.parameters[].description
Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500).

# paths./verzoektypen/{verzoektypeUuid}/versies.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{verzoektypeUuid}/versies.post.responses.201.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.get.description
Een specifiek verzoektype versie opvragen.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.get.summary
Een specifiek verzoektype versie opvragen.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.put.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.patch.description
Een verzoektype versie gedeeltelijk wijzigen.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.patch.summary
Een verzoektype versie gedeeltelijk wijzigen.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.patch.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./verzoektypen/{verzoektypeUuid}/versies/{verzoektypeVersie}.delete.responses.204.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# components.schemas.BijlageType.properties.omschrijving.description
Omschrijving van het soort bijlage, zoals dat door eind gebruikers gezien kan worden in bijvoorbeeld een portaal. Typisch is dit dezelfde omschrijving als die van het INFORMATIEOBJECTTYPE.

# components.schemas.PatchedVerzoek.properties.url.description
De unieke URL van het verzoek binnen deze API.

# components.schemas.PatchedVerzoek.properties.urn.description
De Uniform Resource Name van het Verzoek.

# components.schemas.PatchedVerzoek.properties.uuid.description
Unieke identificatiecode (UUID4) voor het Verzoek.

# components.schemas.PatchedVerzoek.properties.geometrie.description
Point, LineString of Polygon object dat de locatie van het verzoek representeert.

# components.schemas.PatchedVerzoek.properties.aanvraagGegevens.description
JSON data voor validatie van het VerzoekType.

# components.schemas.PatchedVerzoek.properties.versie.description
Indien geen waarde is opgegeven wordt de laatste versie van het VERZOEKTYPE gebruikt.

# components.schemas.PatchedVerzoek.properties.bijlagen.description
Lijst met bijlagen die aan deze bron zijn gekoppeld.

# components.schemas.PatchedVerzoek.properties.kanaal.description
Geeft aan via welk kanaal dit verzoek is binnengekomen.

# components.schemas.PatchedVerzoek.properties.verzoekTaal.description
De taal, volgens het IANA Language Subtag Registry, waarin het verzoek is gedaan. In de meest praktische vorm is dit de taal van de vragen maar het is mogelijk dat de antwoorden in een andere taal zijn gedaan. Bijvoorbeeld door iemand die wel Nederlands kan lezen maar niet kan schrijven.

# components.schemas.PatchedVerzoek.properties.verwerkStatus.description
De initiële status is altijd `geregistreerd`. De status `verwerkt` moet gezet worden door het component dat verantwoordelijk is voor de afhandeling danwel opvolging.

# components.schemas.PatchedVerzoek.properties.verzoekBron.description
Een verwijzing naar de bron waar dit verzoek vandaan komt.

# components.schemas.PatchedVerzoek.properties.verzoekBetaling.description
Verzoek tot betaling gekoppeld aan deze resource.

# components.schemas.PatchedVerzoekType.properties.url.description
De unieke URL van het VerzoekType binnen deze API.

# components.schemas.PatchedVerzoekType.properties.urn.description
De Uniform Resource Name van het VerzoekType.

# components.schemas.PatchedVerzoekType.properties.uuid.description
Unieke identificatiecode (UUID4) voor het VerzoekType

# components.schemas.PatchedVerzoekType.properties.versies.description
Lijst van beschikbare versies voor dit type verzoek.

# components.schemas.PatchedVerzoekType.properties.omschrijving.description
Interne omschrijving van het type verzoek. Bijvoorbeeld om de relatie naar het zaaktype te schetsen.

# components.schemas.PatchedVerzoekTypeVersion.description
Serializer for a specific version of a ``VerzoekType``.

Used in nested endpoints under ``VerzoekType`` and exposes
version fields and a read-only URN reference to the related ``VerzoekType``.

# components.schemas.PatchedVerzoekTypeVersion.properties.url.description
De unieke URL van deze VerzoekType versie binnen deze API.

# components.schemas.PatchedVerzoekTypeVersion.properties.verzoekType.description
Het VerzoekType waartoe deze versie behoort.

# components.schemas.PatchedVerzoekTypeVersion.properties.bijlageTypen.description
Lijst met bijlagen typen die aan deze bron zijn gekoppeld.

# components.schemas.PatchedVerzoekTypeVersion.properties.aanvraagGegevensSchema.description
JSON schema voor validatie van VerzoekType

# components.schemas.PatchedVerzoekTypeVersion.properties.gewijzigdOp.description
Laatste datum waarop de versie is gewijzigd

# components.schemas.PatchedVerzoekTypeVersion.properties.eindeGeldigheid.description
Einde van de geldigheidsduur van de versie, automatisch ingesteld wanneer een nieuwere versie wordt gepubliceerd. Als de waarde wordt ingesteld voordat de versie wordt gepubliceerd, wordt deze overschreven met de publicatiedatum.

# components.schemas.Verzoek.properties.url.description
De unieke URL van het verzoek binnen deze API.

# components.schemas.Verzoek.properties.urn.description
De Uniform Resource Name van het Verzoek.

# components.schemas.Verzoek.properties.uuid.description
Unieke identificatiecode (UUID4) voor het Verzoek.

# components.schemas.Verzoek.properties.geometrie.description
Point, LineString of Polygon object dat de locatie van het verzoek representeert.

# components.schemas.Verzoek.properties.aanvraagGegevens.description
JSON data voor validatie van het VerzoekType.

# components.schemas.Verzoek.properties.versie.description
Indien geen waarde is opgegeven wordt de laatste versie van het VERZOEKTYPE gebruikt.

# components.schemas.Verzoek.properties.bijlagen.description
Lijst met bijlagen die aan deze bron zijn gekoppeld.

# components.schemas.Verzoek.properties.kanaal.description
Geeft aan via welk kanaal dit verzoek is binnengekomen.

# components.schemas.Verzoek.properties.verzoekTaal.description
De taal, volgens het IANA Language Subtag Registry, waarin het verzoek is gedaan. In de meest praktische vorm is dit de taal van de vragen maar het is mogelijk dat de antwoorden in een andere taal zijn gedaan. Bijvoorbeeld door iemand die wel Nederlands kan lezen maar niet kan schrijven.

# components.schemas.Verzoek.properties.verwerkStatus.description
De initiële status is altijd `geregistreerd`. De status `verwerkt` moet gezet worden door het component dat verantwoordelijk is voor de afhandeling danwel opvolging.

# components.schemas.Verzoek.properties.verzoekBron.description
Een verwijzing naar de bron waar dit verzoek vandaan komt.

# components.schemas.Verzoek.properties.verzoekBetaling.description
Verzoek tot betaling gekoppeld aan deze resource.

# components.schemas.VerzoekBetaling.properties.providerKenmerk.description
Een kenmerk (bijv. het PSP ID van Worldline) dat aangeeft welke provider de betaling moet afhandelen.

# components.schemas.VerzoekBetaling.properties.transactieReferentie.description
Een nummer of code die volgt vanuit debetaalprovider na het voltooien van de transactie. Hiermee wordt de transactie administratief gekoppeld aan het verzoek.

# components.schemas.VerzoekBron.properties.naam.description
De naam van de bron applicatie die dit verzoek heeft aangemaakt.

# components.schemas.VerzoekBron.properties.kenmerk.description
Een kenmerk of identificatie van de specifieke instantie die in de bron applicatie heeft geleid tot dit verzoek. Bijvoorbeeld een inzendingsnummer.

# components.schemas.VerzoekType.properties.url.description
De unieke URL van het VerzoekType binnen deze API.

# components.schemas.VerzoekType.properties.urn.description
De Uniform Resource Name van het VerzoekType.

# components.schemas.VerzoekType.properties.uuid.description
Unieke identificatiecode (UUID4) voor het VerzoekType

# components.schemas.VerzoekType.properties.versies.description
Lijst van beschikbare versies voor dit type verzoek.

# components.schemas.VerzoekType.properties.omschrijving.description
Interne omschrijving van het type verzoek. Bijvoorbeeld om de relatie naar het zaaktype te schetsen.

# components.schemas.VerzoekTypeVersion.description
Serializer for a specific version of a ``VerzoekType``.

Used in nested endpoints under ``VerzoekType`` and exposes
version fields and a read-only URN reference to the related ``VerzoekType``.

# components.schemas.VerzoekTypeVersion.properties.url.description
De unieke URL van deze VerzoekType versie binnen deze API.

# components.schemas.VerzoekTypeVersion.properties.verzoekType.description
Het VerzoekType waartoe deze versie behoort.

# components.schemas.VerzoekTypeVersion.properties.bijlageTypen.description
Lijst met bijlagen typen die aan deze bron zijn gekoppeld.

# components.schemas.VerzoekTypeVersion.properties.aanvraagGegevensSchema.description
JSON schema voor validatie van VerzoekType

# components.schemas.VerzoekTypeVersion.properties.gewijzigdOp.description
Laatste datum waarop de versie is gewijzigd

# components.schemas.VerzoekTypeVersion.properties.eindeGeldigheid.description
Einde van de geldigheidsduur van de versie, automatisch ingesteld wanneer een nieuwere versie wordt gepubliceerd. Als de waarde wordt ingesteld voordat de versie wordt gepubliceerd, wordt deze overschreven met de publicatiedatum.

# components.schemas.VerzoekTypeVersionReadOnly.description
Read-only serializer for a ``VerzoekTypeVersion``.

Exposes minimal version information for nested endpoints.

# components.schemas.VerzoekTypeVersionReadOnly.properties.url.description
De unieke URL van deze VerzoekType versie binnen deze API.

# components.securitySchemes.tokenAuth.description
Token-based authentication with required prefix "Token"