API v1

API-documentatie

Met de anonid-API anonimiseert u ID-kopieën vanuit uw eigen software en haalt u alle gegevens en bestanden van uw organisatie op: documenten, PDF's, pasfoto's, compliance-rapporten, dossiers, uploadverzoeken, inbox, verbruik en het logboek.

Interactieve API-referentie Download OpenAPI-spec

Inhoudsopgave tonen

Introductie & snel starten
Authenticatie & API-sleutels
Limieten & abonnement
Document anonimiseren (POST)
Documenten ophalen
Bestanden (PDF, pasfoto, compliance-rapport)
Dossiers
Uploadverzoeken
Inbox & scanner
Organisatie, gebruik & audit-log
Paginering & filters
Foutcodes
Privacy & BSN

Introductie & snel starten

Alle endpoints staan onder https://anonid.nl/api/public/v1. Antwoorden zijn JSON, behalve bestanden (PDF en JPEG). Alle tijden zijn ISO 8601 in UTC; datums op het document zijn altijd JJJJ-MM-DD.

Snel starten: maak een API-sleutel aan, test die met GET /me en anonimiseer daarna uw eerste document met POST /anonymize.

GET/api/public/v1/me

Geeft informatie over de gebruikte sleutel en de organisatie. Handig om een sleutel te testen.

Voorbeeldantwoord

{
  "key": { "id": "…", "name": "HR-koppeling", "prefix": "anid_3f9a", "created_at": "…", "last_used_at": "…" },
  "organization": { "id": "…", "name": "aiopener", "slug": "aiopener" }
}

Mogelijke fouten: 401 · 402 · 429

Sleutel testen

curl https://anonid.nl/api/public/v1/me \
  -H "X-API-Key: $ANONID_API_KEY"

Authenticatie & API-sleutels

Elk verzoek bevat een API-sleutel in de header X-API-Key. Sleutels maakt u aan in het dashboard onder Instellingen → API-sleutels. De sleutel wordt één keer getoond; wij bewaren alleen een SHA-256-hash.

Elke sleutel hoort bij precies één organisatie. U ziet via de API uitsluitend gegevens van die organisatie. Een ingetrokken sleutel werkt direct niet meer.

Bewaar de sleutel als geheim op uw server (bijv. ANONID_API_KEY). Gebruik hem nooit in een browser of app.
Maak per koppeling een aparte sleutel, zodat u er één kunt intrekken zonder de rest te raken.

Limieten & abonnement

De API is beschikbaar in het Business-abonnement. Zonder actief Business-abonnement krijgt u 402.
Anonimiseren (POST /anonymize): maximaal 60 verzoeken per 5 minuten per sleutel, en binnen het maandquotum van uw abonnement.
Ophalen (alle GET-verzoeken): maximaal 300 verzoeken per 5 minuten per sleutel. De header X-RateLimit-Remaining toont wat er nog over is.
Bij 429 vertelt de header Retry-After hoeveel seconden u moet wachten.

Document anonimiseren (POST)

Stuur een scan of foto van een identiteitsbewijs. U ontvangt een PDF waarin de velden van het wettelijk profiel zijn afgeschermd. Het origineel wordt na verwerking direct verwijderd.

Welke velden worden afgeschermd en welke gegevens worden bewaard, bepaalt het wettelijk profiel van het dossier: employer (werkgever), agency_intake (uitzendbureau), wwft (Wwft-instelling), masked_copy (afgeschermde kopie) of record_only (alleen registratie, geen kopie). Zonder dossier_id geldt het standaardprofiel van uw organisatie. Voor employer en agency_intake is een vooraf bevestigd dossier verplicht (anders 409). Bij alle andere profielen worden BSN en MRZ (de machineleesbare code onderaan het document) altijd afgeschermd.

POST/api/public/v1/anonymize

Anonimiseert één identiteitsbewijs (voorkant, optioneel achterkant). Body als multipart/form-data.

Parameters

Naam	Type	Verplicht	Uitleg
file	bestand	ja	Voorkant of het hele document. JPG, PNG of PDF, maximaal 10 MB.
file_back	bestand	nee	Achterkant. Wordt alleen samengevoegd als u twee bestanden stuurt; verplicht bij profielen die de achterkant nodig hebben (anders 400).
dossier_id	uuid	nee	Dossier waarvan het wettelijk profiel de afscherming, bewaarde gegevens en bewaartermijn bepaalt.
purpose	string	nee	Doel van de kopie (3–200 tekens), bijv. "Huurcontract Prinsengracht 42". Wordt als diagonaal watermerk "KOPIE – doel" op elke pagina gezet en bij het document bewaard.
extract	boolean	nee	1 of true: geef ook de uitgelezen gegevens terug. Gelijk aan header X-Extract: 1.
format	string	nee	json: ontvang een JSON-antwoord met de PDF in base64. Gelijk aan header Accept: application/json.

Headers bij elk PDF-antwoord: X-Document-Id, X-Document-Type en Content-Disposition met een nette bestandsnaam (voornamen-achternaam-vervaldatum.pdf).
Met extract=1 extra: X-Anonymid-Extracted (base64-JSON van de uitgelezen gegevens) en X-Anonymid-Expired (true/false), plus leesbare headers X-Extracted-Full-Name, X-Extracted-Surname, X-Extracted-Given-Names (URL-gecodeerd), X-Extracted-Date-Of-Birth en X-Extracted-Date-Of-Expiry.
X-anonid-Extracted en X-anonid-Expired zijn verouderde namen die nog worden meegestuurd. Gebruik in nieuwe code de X-Anonymid-namen.
name_confidence is high als de gedrukte naam en de MRZ overeenkomen; bij medium of low is de splitsing afgeleid en controleert u de naam beter.

Voorbeeldantwoord

Standaard: application/pdf. Met format=json:

{
  "document_id": "6f1c…",
  "document_type": "id_card",
  "pdf_base64": "JVBERi0xLjQK…",
  "extracted": {
    "full_name": "JANSEN, MARIA ANNA",
    "surname": "Jansen",
    "given_names": "Maria Anna",
    "name_confidence": "high",
    "date_of_birth": "1985-04-16",
    "date_of_expiry": "2031-08-30",
    "date_of_issue": "2021-08-30",
    "place_of_birth": "Utrecht",
    "document_number": "NR89DR7C4",
    "document_number_valid": true,
    "issuing_authority": "Burgemeester van Utrecht",
    "issuing_municipality": "Utrecht",
    "bsn": null
  },
  "expired": false
}

Mogelijke fouten: 400 · 401 · 402 · 404 · 409 · 413 · 415 · 422 · 429 · 5xx

Anonimiseren met uitgelezen gegevens

curl -X POST https://anonid.nl/api/public/v1/anonymize \
  -H "X-API-Key: $ANONID_API_KEY" \
  -F "file=@voorkant.jpg" \
  -F "file_back=@achterkant.jpg" \
  -F "purpose=Huurcontract Prinsengracht 42" \
  -F "extract=1" \
  -o geanonimiseerd.pdf -D headers.txt

Documenten ophalen

GET/api/public/v1/documents

Lijst van documenten, nieuwste eerst. Per item dezelfde velden als het detail, zonder tijdelijke downloadlinks.

Parameters

Naam	Type	Verplicht	Uitleg
source	string	nee	web, api, email (magic upload-link), scanner of folder (mappen scannen).
dossier_id	uuid	nee	Alleen documenten uit dit dossier.
document_type	string	nee	passport, id_card, driving_license, residence_permit of unknown.
created_after	datum	nee	Alleen items aangemaakt op of na dit moment (ISO 8601, bijv. 2026-01-01).
created_before	datum	nee	Alleen items aangemaakt vóór dit moment (ISO 8601).
expiring_before	datum	nee	Alleen documenten met een vervaldatum vóór deze datum. Handig om verlopen ID's te vinden.
reviewed	boolean	nee	false = nog te controleren (inbox), true = goedgekeurd (archief).
q	string	nee	Zoekt in naam, label en doel.
limit	integer	nee	Aantal resultaten per pagina, 1–100. Standaard 25.
cursor	string	nee	Waarde van next_cursor uit het vorige antwoord, voor de volgende pagina.

Voorbeeldantwoord

{
  "data": [ { "id": "6f1c…", "document_type": "id_card", "extracted": { … }, "links": { … } } ],
  "next_cursor": "MjAyNi0xMC0wMVQwOTo1MTo…"
}

Mogelijke fouten: 400 · 401 · 402 · 429

GET/api/public/v1/documents/{id}

Alle gegevens van één document, inclusief alle uitgelezen velden en links naar de bestanden. anonymized_url is een tijdelijke downloadlink (10 minuten).

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Uitgelezen velden zijn alleen gevuld als het wettelijk profiel die gegevens laat bewaren. Lege velden zijn null.
expired is true als de vervaldatum van het document vandaag of eerder is.

Voorbeeldantwoord

{
  "id": "6f1c…",
  "created_at": "2026-10-01T09:51:12Z",
  "filename": "maria-anna-jansen-2031-08-30.pdf",
  "document_type": "id_card",
  "source": "scanner",
  "label": null,
  "purpose": "Indiensttreding",
  "dossier_id": "a3e0…",
  "redacted_fields": ["bsn", "mrz", "photo"],
  "hash_sha256": "9b2c…",
  "has_stored_copy": true,
  "has_file": true,
  "has_portrait": false,
  "reviewed_at": "2026-10-01T10:02:00Z",
  "data_edited_at": null,
  "expires_at": "2026-10-31T09:51:12Z",
  "expired": false,
  "extracted": {
    "full_name": "JANSEN, MARIA ANNA",
    "surname": "Jansen",
    "given_names": "Maria Anna",
    "name_confidence": "high",
    "date_of_birth": "1985-04-16",
    "date_of_expiry": "2031-08-30",
    "date_of_issue": "2021-08-30",
    "place_of_birth": "Utrecht",
    "document_number": "NR89DR7C4",
    "document_number_valid": true,
    "issuing_authority": "Burgemeester van Utrecht",
    "issuing_municipality": "Utrecht",
    "bsn": null
  },
  "links": {
    "self": "https://anonid.nl/api/public/v1/documents/6f1c…",
    "pdf_url": "https://anonid.nl/api/public/v1/documents/6f1c…/pdf",
    "portrait_url": null,
    "report_url": "https://anonid.nl/api/public/v1/documents/6f1c…/report"
  },
  "anonymized_url": "https://…signed…"
}

Mogelijke fouten: 400 · 401 · 402 · 404 · 429

Bestanden (PDF, pasfoto, compliance-rapport)

GET/api/public/v1/documents/{id}/pdf

De geanonimiseerde PDF als download, met een nette bestandsnaam in Content-Disposition.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Voorbeeldantwoord

application/pdf

Mogelijke fouten: 401 · 402 · 404 not_found · 404 file_expired · 429

GET/api/public/v1/documents/{id}/portrait

De pasfoto-uitsnede (JPEG). Alleen beschikbaar als de pasfoto niet is afgeschermd; wordt samen met het document verwijderd.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Voorbeeldantwoord

image/jpeg

Mogelijke fouten: 401 · 402 · 404 no_portrait · 429

GET/api/public/v1/documents/{id}/report

Het compliance-rapport (PDF, één A4) met afgeschermde velden, bewaarde gegevens, bewaartermijn, bron en hash. Met ?format=json dezelfde gegevens als JSON.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).
format	string	nee	json voor een JSON-antwoord in plaats van PDF.

Voorbeeldantwoord

{
  "document_id": "6f1c…",
  "organization": "aiopener",
  "document_type": "id_card",
  "source": "scanner",
  "hash_sha256": "9b2c…",
  "redacted_fields": ["bsn", "mrz"],
  "stored_data_fields": ["full_name", "date_of_expiry"],
  "legal_profile": "employer",
  "profile_label": "Werkgever (loonheffing)",
  "legal_basis": "…",
  "retention_days": 30,
  "created_at": "…",
  "expires_at": "…",
  "dossier_id": "a3e0…"
}

Mogelijke fouten: 401 · 402 · 404 · 429

PDF downloaden

curl https://anonid.nl/api/public/v1/documents/$DOC_ID/pdf \
  -H "X-API-Key: $ANONID_API_KEY" -OJ

Dossiers

Een dossier legt vast onder welk wettelijk profiel, met welke afscherming, bewaarde gegevens en bewaartermijn een persoon is verwerkt. Deze vastlegging verandert niet als u later uw standaardinstellingen aanpast.

GET/api/public/v1/dossiers

Lijst van dossiers, nieuwste eerst.

Parameters

Naam	Type	Verplicht	Uitleg
status	string	nee	active, ended of destroyed.
legal_profile	string	nee	employer, agency_intake, wwft, masked_copy of record_only.
created_after	datum	nee	Alleen items aangemaakt op of na dit moment (ISO 8601, bijv. 2026-01-01).
created_before	datum	nee	Alleen items aangemaakt vóór dit moment (ISO 8601).
limit	integer	nee	Aantal resultaten per pagina, 1–100. Standaard 25.
cursor	string	nee	Waarde van next_cursor uit het vorige antwoord, voor de volgende pagina.

Voorbeeldantwoord

{
  "data": [ { "id": "a3e0…", "legal_profile": "employer", "status": "active", … } ],
  "next_cursor": null
}

Mogelijke fouten: 400 · 401 · 402 · 429

GET/api/public/v1/dossiers/{id}

Alle dossiergegevens met gekoppelde documenten, bevestigingen van het profiel en vastgelegde afwijkingen van het advies.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Voorbeeldantwoord

{
  "id": "a3e0…",
  "legal_profile": "employer",
  "profile_label": "Werkgever (loonheffing)",
  "legal_basis": "…",
  "purpose": "Indiensttreding",
  "label": null,
  "status": "active",
  "redacted_fields": ["mrz", "photo"],
  "stored_data_fields": ["full_name", "bsn", "date_of_expiry"],
  "retention_strategy": "…",
  "retention_days": null,
  "destroy_at": null,
  "next_review_at": "2027-10-01T…",
  "relationship_end_date": null,
  "watermark": "aiopener",
  "advice_fields": ["…"],
  "advice_stored_data_fields": ["…"],
  "advice_retention_days": null,
  "documents": [ { "id": "6f1c…", "document_type": "id_card", "source": "web", "url": "…" } ],
  "legal_profile_confirmations": [ { "statement": "…", "confirmed_at": "…" } ],
  "advice_deviations": [ { "kind": "field", "field_key": "photo", "advice": "…", "choice": "…" } ],
  "report_url": "https://anonid.nl/api/public/v1/dossiers/a3e0…/report"
}

Mogelijke fouten: 400 · 401 · 402 · 404 · 429

GET/api/public/v1/dossiers/{id}/report

Compliance-rapport op dossierniveau (PDF, één A4): profiel, grondslag, afscherming, bewaarde gegevens, bewaartermijn en een regel per document.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Voorbeeldantwoord

application/pdf

Mogelijke fouten: 401 · 402 · 404 · 429

Uploadverzoeken

Uploadverzoeken zijn de magic links waarmee u iemand vraagt zelf een ID-kopie aan te leveren. U kunt ze in de app of via de API aanmaken; geheime codes en tokens worden nooit teruggegeven.

Belangrijk: de upload_url wordt uitsluitend in het antwoord op het aanmaken (POST) teruggegeven. Wij bewaren alleen een hash van de link, dus daarna is hij nooit meer op te vragen. Bewaar of verstuur hem direct.

Aanmaken is begrensd op 30 verzoeken per uur per API-sleutel (429 met Retry-After). Elk aangemaakt verzoek telt mee voor uw documentquotum en komt in het logboek als upload_request.created.

POST/api/public/v1/upload-requests

Maak een uploadverzoek (magic link) aan. Met send_email=true verstuurt anonid de uitnodiging in de huisstijl van uw organisatie; met send_email=false verstuurt u de link zelf.

Parameters

Naam	Type	Verplicht	Uitleg
recipient_email	string	ja	E-mailadres van de persoon die het ID aanlevert. Ook nodig bij send_email=false: de verificatiecode gaat naar dit adres.
label	string	nee	Eigen kenmerk, max. 120 tekens (bijv. naam of dossiernummer).
purpose	string	nee	Doel van de verwerking, 3–200 tekens. Wordt in de uitnodiging en het rapport getoond.
dossier_id	uuid	nee	Bestaand dossier. Verplicht voor de profielen employer en agency_intake (eerst bevestigen in de app).
legal_profile	string	nee	masked_copy, wwft of record_only als u geen dossier_id meegeeft. Zonder beide geldt het standaardprofiel van uw organisatie.
expires_in_days	integer	nee	Geldigheid van de link, 1–90 dagen. Standaard 7.
reminder_interval_days	integer	nee	Automatische herinnering elke N dagen (1–30). Leeg = geen herinneringen.
retention_days	integer	nee	Bewaartermijn in dagen (0–3650) voor een nieuw dossier. Leeg = organisatiestandaard.
send_email	boolean	nee	Standaard true. false = geen mail; u verstuurt de upload_url zelf.

Voorbeeldantwoord

201 application/json

{
  "id": "c71d…",
  "upload_url": "https://anonid.nl/u/Yk3…",
  "expires_at": "2026-10-08T11:23:00Z",
  "status": "open",
  "dossier_id": "a3e0…",
  "email_sent": true
}

Mogelijke fouten: 400 · 401 · 402 · 404 · 409 · 429

GET/api/public/v1/upload-requests

Lijst van uploadverzoeken met afgeleide status: open, geverifieerd, gebruikt, verlopen of ingetrokken.

Parameters

Naam	Type	Verplicht	Uitleg
dossier_id	uuid	nee	Alleen verzoeken voor dit dossier.
source	string	nee	web (aangemaakt in de app) of api.
created_after	datum	nee	Alleen items aangemaakt op of na dit moment (ISO 8601, bijv. 2026-01-01).
created_before	datum	nee	Alleen items aangemaakt vóór dit moment (ISO 8601).
limit	integer	nee	Aantal resultaten per pagina, 1–100. Standaard 25.
cursor	string	nee	Waarde van next_cursor uit het vorige antwoord, voor de volgende pagina.

Voorbeeldantwoord

{
  "data": [
    {
      "id": "c71d…",
      "status": "gebruikt",
      "source": "api",
      "label": "Nieuwe medewerker",
      "purpose": "Indiensttreding",
      "recipient_email": "m.jansen@example.nl",
      "created_at": "…",
      "expires_at": "…",
      "verified_at": "…",
      "used_at": "…",
      "reminder_count": 1,
      "last_reminder_at": "…",
      "dossier_id": "a3e0…",
      "document_id": "6f1c…"
    }
  ],
  "next_cursor": null
}

Mogelijke fouten: 400 · 401 · 402 · 429

GET/api/public/v1/upload-requests/{id}

Eén uploadverzoek.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Mogelijke fouten: 400 · 401 · 402 · 404 · 429

Uploadverzoek aanmaken — anonid verstuurt de mail (send_email: true)

curl -X POST https://anonid.nl/api/public/v1/upload-requests \
  -H "X-API-Key: $ANONID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recipient_email":"m.jansen@example.nl","label":"Nieuwe huurder","purpose":"Huurovereenkomst","legal_profile":"masked_copy","expires_in_days":7,"reminder_interval_days":2}'

Uploadverzoek aanmaken — u verstuurt de link zelf (send_email: false)

curl -X POST https://anonid.nl/api/public/v1/upload-requests \
  -H "X-API-Key: $ANONID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recipient_email":"m.jansen@example.nl","dossier_id":"a3e0…","send_email":false}'
# Bewaar upload_url direct: deze is later niet meer op te vragen.

Inbox & scanner

Ontvangen e-mails via het scanneradres of via magic links, met hun bijlagen en het document dat eruit is gemaakt.

GET/api/public/v1/inbound-emails

Lijst van ontvangen e-mails, nieuwste eerst.

Parameters

Naam	Type	Verplicht	Uitleg
status	string	nee	Verwerkingsstatus, bijv. processed of failed.
created_after	datum	nee	Alleen items aangemaakt op of na dit moment (ISO 8601, bijv. 2026-01-01).
created_before	datum	nee	Alleen items aangemaakt vóór dit moment (ISO 8601).
limit	integer	nee	Aantal resultaten per pagina, 1–100. Standaard 25.
cursor	string	nee	Waarde van next_cursor uit het vorige antwoord, voor de volgende pagina.

Voorbeeldantwoord

{
  "data": [
    {
      "id": "e9b2…",
      "from_email": "scanner@kantoor.nl",
      "to_email": "aiopener@scan.anonid.nl",
      "subject": "Scan",
      "received_at": "…",
      "status": "processed",
      "error": null,
      "processed_at": "…",
      "upload_request_id": null,
      "attachments": [ { "filename": "scan.pdf", "mime_type": "application/pdf", "size_bytes": 182311, "document_id": "6f1c…" } ]
    }
  ],
  "next_cursor": null
}

Mogelijke fouten: 400 · 401 · 402 · 429

GET/api/public/v1/inbound-emails/{id}

Eén ontvangen e-mail met bijlagen.

Parameters

Naam	Type	Verplicht	Uitleg
id	uuid	ja	Het id van het item (in het pad).

Mogelijke fouten: 400 · 401 · 402 · 404 · 429

Organisatie, gebruik & audit-log

GET/api/public/v1/organization

Naam, juridische naam, adres, standaardprofiel, bewaartermijn, scanneradres en scannerinstellingen.

Mogelijke fouten: 401 · 402 · 429

GET/api/public/v1/redaction-profiles

De afschermregels van uw organisatie per land en profiel.

Mogelijke fouten: 401 · 402 · 429

GET/api/public/v1/usage

Uw abonnement, status, verbruik deze maand en in totaal, en de bijbehorende limieten.

Voorbeeldantwoord

{
  "plan_tier": "business",
  "status": "active",
  "billing_interval": "month",
  "cancel_at_period_end": false,
  "current_period_end": "…",
  "monthly_limit": 2000,
  "lifetime_limit": null,
  "monthly_used": 143,
  "lifetime_used": 1202,
  "period_start": "2026-10-01T00:00:00.000Z"
}

Mogelijke fouten: 401 · 402 · 429

GET/api/public/v1/audit-log

Het logboek van uw organisatie, inclusief opvragingen via de API.

Parameters

Naam	Type	Verplicht	Uitleg
action	string	nee	Bijv. document.anonymized, api.data_read of api.bsn_read.
target_type	string	nee	Bijv. document of dossier.
target_id	string	nee	Id van het betrokken item.
created_after	datum	nee	Alleen items aangemaakt op of na dit moment (ISO 8601, bijv. 2026-01-01).
created_before	datum	nee	Alleen items aangemaakt vóór dit moment (ISO 8601).
limit	integer	nee	Aantal resultaten per pagina, 1–100. Standaard 25.
cursor	string	nee	Waarde van next_cursor uit het vorige antwoord, voor de volgende pagina.

Mogelijke fouten: 400 · 401 · 402 · 429

Paginering & filters

Lijsten zijn gesorteerd op created_at, nieuwste eerst.
Elk lijstantwoord heeft de vorm { "data": [...], "next_cursor": "..." }. Geef next_cursor mee als cursor voor de volgende pagina; null betekent dat u alles hebt.
limit is maximaal 100 (standaard 25).
Filters combineert u vrij als queryparameters. Datums in ISO 8601. Een ongeldige waarde geeft 400 invalid_parameter.

Alle verlopen ID's ophalen

curl "https://anonid.nl/api/public/v1/documents?expiring_before=2026-10-01&limit=100" \
  -H "X-API-Key: $ANONID_API_KEY"

Foutcodes

Fouten komen terug als JSON: { "error": "leesbare uitleg", "code": "machinecode" }. Tijdelijke fouten (429 en 5xx) mag u opnieuw proberen: maximaal 3 keer met oplopende wachttijd (ongeveer 1, 2 en 4 seconden). Bij 429 wacht u het aantal seconden uit Retry-After. Andere fouten zijn blijvend; opnieuw proberen helpt dan niet.

Status	Code	Betekenis	Opnieuw proberen
400	invalid_parameter	Een parameter of bestand ontbreekt of is ongeldig.	nee
401	invalid_api_key / revoked_api_key	Geen, onjuiste of ingetrokken API-sleutel.	nee
402	plan_required / payment_past_due	De API vereist een actief Business-abonnement, of er staat een betaling open.	nee
404	not_found	Het item bestaat niet of hoort niet bij uw organisatie.	nee
404	file_expired / no_portrait	Het bestand is door de bewaartermijn verwijderd, of er is geen pasfoto.	nee
402	quota_over_monthly / quota_over_lifetime	Het documentquotum van uw abonnement is bereikt (ook bij het aanmaken van uploadverzoeken).	nee
409	dossier_required	Het wettelijk profiel vereist eerst een bevestigd dossier (dossier_id).	nee
413	—	Bestand groter dan 10 MB.	nee
415	—	Bestandstype niet ondersteund (alleen JPG, PNG of PDF).	nee
422	—	Het document kon niet worden herkend of verwerkt.	nee
429	rate_limited	Limiet bereikt of tijdelijk druk. Volg de Retry-After-header.	ja
500	internal_error	Onverwachte fout aan onze kant.	ja
502 / 503 / 504	—	Verwerkingsdienst tijdelijk niet bereikbaar.	ja

Privacy & BSN

De API geeft alleen gegevens terug die volgens het wettelijk profiel van het dossier zijn bewaard. Wat niet bewaard mocht worden, bestaat ook niet in onze database.
Het BSN (burgerservicenummer) wordt alleen bewaard en teruggegeven bij het profiel employer, waar de wet dat voor de loonadministratie vraagt. In alle andere gevallen is bsn null.
Elke opvraging van persoonsgegevens wordt in het logboek vastgelegd als api.data_read, met de sleutel, het item en welke velden (nooit de waarden). Bevat een antwoord een BSN, dan komt er een extra regel api.bsn_read bij. U ziet dit via GET /audit-log.
Downloadlinks in anonymized_url verlopen na 10 minuten. Bestanden worden na de bewaartermijn definitief verwijderd; de API geeft dan 404 file_expired.
Gebruik de API alleen vanaf uw eigen server. Stuur nooit een API-sleutel naar een browser of mobiele app.