Request a password reset
POST/auth/forgot-password
No token. One of the calls you make before you have one. Send X-Tenant-Code where the operation lists it — that is which tenant you are asking about, not proof of who you are.
Emails a single-use reset link to the address given, if it belongs to an account in this tenant.
Always returns 204, whether or not the address is registered — otherwise the response would be a way to test which emails have accounts. Show the person a message that says as much ("if that address is registered, we've sent a link") rather than a confirmation you cannot actually make.
The person's current password keeps working until they use the link. Repeated requests within a short window are quietly suppressed.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 500
OK
Malformed request — validation failure, or a header such as Idempotency-Key is missing or not a UUID.
Missing, expired, or untrusted bearer token.
Authenticated but not permitted — the caller's role or scope does not grant this operation, or the resource belongs to another tenant.
The referenced wallet, transaction, user, or tenant does not exist within the caller's tenant.
Idempotency conflict — a request with this Idempotency-Key is still in flight. Retry once it settles. A key belonging to an already-completed request is NOT an error: the original response is replayed with its original status.
The request is well-formed but violates a business rule — for example a posting that would breach a wallet fund's balance floor, a transaction type not enabled for the tenant, a per-transaction or daily issuance cap, or an operation on a frozen wallet.
Unexpected server error.