> For the complete documentation index, see [llms.txt](https://www.nl-portal.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.nl-portal.nl/4.x/fundamentals/document-filtering.md).

# Document filtering

Het is mogelijk om te bepalen welke Documenten een gebruiker te zien krijgt. Documenten worden gefilterd voor dat ze geretourneerd worden.

## Configuratie

Deze functionalitiet maakt gebruik van twee whitelists in de spring properties van jouw applicatie. Beide properties hebben zijn eigen [opties en standaardwaardes](#opties). Standaardwaardes worden gebruikt als deze properties niet configureerd zijn.

1. `nl-portal.config.documentenapis.properties.status-whitelist`
2. `nl-portal.config.documentenapis.properties.vertrouwelijkheidsaanduiding-whitelist`

### Opties

De volgende opties zijn van toepassing bij de whitelists en zijn gebaseerd op de [enkelvoudiginfromatieobject](https://openzaak.ritense.opengem.nl/documenten/api/v1/schema/#tag/enkelvoudiginformatieobjecten) Documenten API specificatie.

| Status            | Standaardwaarde |
| ----------------- | :-------------: |
| ter\_vaststelling |                 |
| in\_bewerking     |                 |
| definitief        |        X        |
| gearchiveerd      |        X        |

| Vertrouwelijkheidaanduiding | Standaardwaarde |
| --------------------------- | :-------------: |
| openbaar                    |        X        |
| beperkt\_openbaar           |        X        |
| intern                      |        X        |
| zaakvertrouwelijk           |        X        |
| vertrouwelijk               |                 |
| confidentieel               |                 |
| geheim                      |                 |

### Voorbeeld

De volgende spring properties zorgen ervoor dat alle Informatieobjecten die bij jouw Zaak horen worden geretourneerd.

```yaml
nl-portal:
    config:
        documentenapis:
            vertrouwelijkheidsaanduiding-whitelist:
                - openbaar
                - beperkt_openbaar
                - intern
                - vertrouwelijk
                - zaakvertrouwelijk
                - confidentieel
                - geheim
                - zeer_geheim
            status-whitelist:
                - ter_vaststelling
                - in_bewerking
                - definitief
                - gearchiveerd
```
