Dit register wordt bijgehouden om te voldoen aan de vereisten van de EU Data Act. Het biedt een actueel overzicht van datastructuren, formaten, relevante standaarden en open interoperabiliteitsspecificaties voor alle exporteerbare data.
Opmerking: Deze pagina is onderhevig aan wijzigingen.
Laatst bijgewerkt: v.1.0 – 12 september 2025.
Structuren & formaten
- OpenAPI (Swagger) – machine-leesbare REST-beschrijving van endpoints.
- Dataformaten: JSON
- Tijdstempels: Unix-tijdstempel
- Documenten: base64
- Paginering: let op paginering. Lees meer hier.
Toegepaste standaarden en open interoperabiliteitsspecificaties
Penneo hanteert een RESTful API-ontwerp, gebruikmakend van standaarden met duidelijke resource-endpoints.
Penneo gebruikt het JSON-dataformaat voor eenvoudige en universele gegevensuitwisseling.
Penneo vertrouwt op OAuth 2.0 voor authenticatie. Dit is een veilige, open standaard waarmee toegang aan derden kan worden verleend zonder wachtwoorden te delen.
Penneo gebruikt TLS 1.2+ om te waarborgen dat alle overgedragen data veilig versleuteld is.
Toegang & authenticatie
- Zie API Authenticatie.
- Wij raden aan OAuth API-sleutels te gebruiken.
Organisaties hebben uitsluitend toegang tot data binnen hun eigen Penneo-omgeving.
Data exporteren
Via Penneo Support:
De klant dient de benodigde API-referenties te verstrekken, of Penneo te machtigen deze aan te maken, om de volledige export van klantdata mogelijk te maken.
Penneo zal de geëxporteerde klantdata uploaden naar een onderling overeengekomen, beveiligd platform voor het delen van bestanden.
Penneo zal de personen die in de overstapmelding (Switching Notice) zijn aangewezen, voorzien van beveiligde inloggegevens om toegang te krijgen tot de geëxporteerde data op het overeengekomen platform.
Gebruik van de API:
- Authenticeer met een van de door Penneo ondersteunde authenticatiemethoden
- Het gebruik van de Super API-gebruiker API-referenties maakt export van data op accountniveau mogelijk.
- Houd er rekening mee dat de Super API-gebruiker alleen GET-verzoeken ondersteunt.
- Verkrijg een lijst van alle dossiers via de GET casefile list endpoint
- Voor grote organisaties rekening houden met paginering
- Voor elk casefileId gebruik de GET casefile details endpoint
- Data van dossiers, documenten, ondertekenaars en andere relevante gegevens kunnen uit de respons worden geëxporteerd.
- Gebruik het documentId uit de dossierdetails om de base64-gecodeerde PDF op te halen via GET the PDF document as a file
- Om te identificeren aan welke map het dossier is gekoppeld, gebruik de GET the folder for the casefile
- Bijlagen kunnen worden geïdentificeerd op de ondertekenaar met behulp van de signerId op de GET the meta data for files
- Met behulp van de fileId kan het bestand worden gedownload via GET the file
Opmerking 1: Zie de gekoppelde documentatie voor filteropties.
Opmerking 2: Het is niet mogelijk om de actieve gebruikerslijst (inclusief userName, userId, email en rol) via de API op te halen.
Exporteerbare data
Bezoek onze voorwaarden.