Dit register wordt bijgehouden om te voldoen aan de vereiste van de EU Data Act voor een actueel register. Het bevat details over de datastructuren, formaten, relevante standaarden en open interoperabiliteitsspecificaties voor alle exporteerbare gegevens.
Opmerking: Deze pagina kan onderhevig zijn aan wijzigingen. Laatst bijgewerkt: v.1.0, 12 september 2025.
Structuren & formaten
- OpenAPI (Swagger) – Machineleesbare REST-beschrijving van eindpunten.
- Dataformaten: JSON
- Tijdstempels: Unix-tijdstempel
- Documenten: base64
- Paginering: houd rekening met paginering. Lees meer hier.
Toegepaste standaarden en open interoperabiliteitsspecificaties
Penneo past een RESTful API-ontwerp toe met standaard en duidelijke resource-eindpunten.
Penneo gebruikt het JSON-dataformaat voor eenvoudige en universele gegevensuitwisseling.
Penneo vertrouwt op OAuth 2.0 voor authenticatie. Hiermee implementeren we een veilige, open standaard voor het verlenen van toegang aan derden, zonder dat er wachtwoorden gedeeld hoeven te worden.
- Penneo gebruikt TLS 1.2+ om te zorgen dat alle overgedragen gegevens veilig versleuteld zijn.
Toegang & authenticatie
- Zie API Authenticatie.
- Wij raden aan OAuth API-sleutels te gebruiken.
- Organisaties hebben toegang tot gegevens binnen hun eigen Penneo-omgeving
Gegevens exporteren
Via Penneo-ondersteuning:
- De Klant dient de noodzakelijke API-gegevens te verstrekken of Penneo te machtigen deze aan te maken om de volledige export van de Klantgegevens mogelijk te maken.
- Penneo zal de geëxporteerde Klantgegevens uploaden naar een onderling overeengekomen beveiligd platform voor het delen van bestanden.
- Penneo zal de in de Wisselmelding van de Klant aangewezen personen voorzien van beveiligde inloggegevens om toegang te krijgen tot de geëxporteerde Klantgegevens op het overeengekomen platform.
De API gebruiken:
- Authenticeer met behulp van een van de door Penneo ondersteunde authenticatiemethoden
- Met de API-inloggegevens van de Super API-gebruiker kunnen gegevens op accountniveau worden geëxporteerd.
- Let op: de Super API-gebruiker ondersteunt uitsluitend GET-verzoeken.
- Verkrijg een lijst van alle casefiles met behulp van het GET casefile list-endpoint
- Overweeg bij grote organisaties paginering
- Gebruik voor elke casefileId het GET casefile details-endpoint
- Casefile-, document-, ondertekenaar- en andere relevante gegevens kunnen uit de respons worden geëxporteerd
- Gebruik de documentId uit de casefile details om de met base64 gecodeerde PDF te verkrijgen via GET the PDF document as a file
- Gebruik het GET the folder for the casefile om te bepalen aan welke map de casefile is gekoppeld
- Bijlagen kunnen bij de ondertekenaar worden geïdentificeerd met de signerId via 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 via de API de Active user list op te halen met userName, userId, e-mailadres en rol.
Exporteerbare gegevens
Ga naar onze voorwaarden.
Support
- Neem gerust contact op met onze support