Request a password-reset email
POST/auth/forgot-password
Sends a password-reset link to the provided email (single-use, 60 min expiry). Response is always 202 whether or not the email exists (to prevent user enumeration). Public endpoint, throttled to 5/min/IP.
Request
Responses
- 200
- 201
- 400
- 409
- 429
- 500
Accepted — if an account exists, an email has been sent.
Resource created. Body follows the shared { data, meta } envelope; data is the newly-created resource.
Payload invalid.
The request conflicts with the current state of the target resource — a duplicate unique field on registration, an idempotency-key replay with a different payload, or a webhook eventId that has already been processed. error.code may be CONFLICT or IDEMPOTENCY_CONFLICT depending on the cause.
Rate limit exceeded. Global default is 120 requests/minute per IP; auth-flow, OTP, self-registration, WebAuthn, IRA lookup, and public-lead endpoints carry tighter per-endpoint limits. Retry after the delay indicated by the Retry-After header.
Response Headers
Seconds to wait before retrying.
Unhandled server error. The response carries a meta.requestId correlator you can hand to platform operations to trace the failure through structured logs and the hash-chained audit trail. Retry with the same Idempotency-Key header if the endpoint accepts idempotency.