Password

Overview

These endpoints handle customer password recovery and changes — request a reset link by email, reset the password with the emailed token, or change it while signed in.


How It Works

  1. Forgot - The customer requests a reset link, sent to their email.
  2. Reset - They open the link and submit a new password with the token it carries.
  3. Update - A signed-in customer changes their password directly (no email round-trip).

Example: A customer who forgot their password uses Forgot → Reset; a signed-in customer uses Update.


API Endpoints

MethodEndpointDescription
POST/api/v1/sdk/password/forgotForgot password
POST/api/v1/sdk/password/resetReset password
POST/api/v1/sdk/password/updateUpdate password

Important Behaviors

  • Forgot/Reset are public; Update requires a bearer token.
  • No account disclosure: Forgot returns 404 for an unknown email rather than revealing whether it exists.
  • Strong passwords: When password enforcement is enabled, new passwords must meet complexity rules.