Member password reset

The member password reset flow is a multi-step process that includes sending an email to the registered email address to reset a forgotten password and enable member authentication.

Member password reset flow

Create a password reset code

The password reset flow is initiated by calling the CreatePasswordResetCode endpoint. This endpoint creates a single-use password reset code and sends it to the member's registered email address.

The CreatePasswordResetCode endpoint can be called with the member's current email or username.

{
  "email": "string",
  "username": "string"
}

Validate the password reset code

As the created single-use password reset code may have expired, or may have already been used, use the ValidatePasswordResetCode to validate it.

{
  "resetCode": "string"
}

This endpoint returns an isValid response, indicating whether the password reset code can be used.

{
  "isValid": true
}

Reset member password

Finally, use the ResetPassword endpoint with the validated resetCode and updated password to set the member's new password.

{
  "resetCode": "string",
  "password": "string"
}