POST/api/auth/forgot-password

Start het resetten van een wachtwoord: bestaat er een account met het opgegeven e-mailadres, dan ontvangt dit een e-mail met een resetlink.

Stuur het e-mailadres van het account in het veld `email`. Het antwoord `{"ok":true}` is opzettelijk altijd gelijk – ongeacht of een account bestaat – zodat via deze endpoint niet kan worden vastgesteld welke adressen geregistreerd zijn. Het nieuwe wachtwoord wordt vervolgens ingesteld met het token uit de e-mail via `POST /api/auth/reset-password`. Ontbreekt het veld `email` of is het leeg, dan antwoordt de endpoint met 400 `VALIDATION_ERROR`. Ter bescherming tegen misbruik is het aantal aanvragen per IP-adres beperkt (429 `RATE_LIMIT_EXCEEDED`).

Overzicht

Aanroep: POST /api/auth/forgot-password. Dit endpoint hoort bij de groep ‘Authenticatie’ van de API van Zentor App. Het is openbaar toegankelijk en vereist geen authenticatie. De aanroep is idempotent: herhaalde aanroepen met dezelfde gegevens leveren hetzelfde resultaat op. Verplichte parameters: email (body). Gedocumenteerde foutgevallen: 400 VALIDATION_ERROR. Het voorbeeldantwoord hieronder toont de opbouw van een geslaagd antwoord in JSON-formaat.

Auth & beveiliging

Geen authenticatie vereist

Idempotent: Ja

Parameters

email(body, string, vereist)— E-mailadres van het account

Voorbeeld-request

{"email":"user@example.com"}

Voorbeeld-response

{"ok":true}

Foutcodes

400 VALIDATION_ERROR — Het veld `email` ontbreekt of is leeg.

Geverifieerd gedrag

Het antwoord is 200 `{"ok":true}`, ongeacht of het account bestaat; een ontbrekend e-mailveld levert 400 `VALIDATION_ERROR` op.

Authenticatie

Gerelateerde artikelen

← Authenticatie