This API is the final endpoint in setting your password via the "code" method. We utilize a security token granted with successful access to the send code API, along with the original email, and new password information. The token expires in 30 minutes, and the process will need to be restarted in this case.
POST
api/v1/customer/auth/send-password-reset
Request Parameters
Parameter | Value / Type | Required |
|---|---|---|
STRING | true | |
password | STRING | true |
password_confirmation | STRING | true |
code | STRING | true |
token | STRING | true |
Sample Responses
{
"status": true,
"message": "Your password has been successfully reset"
}{
"status": false,
"errorCode": "TOKEN_EXPIRED",
"message": "Security token has expired was not found"
}{
"status": false,
"errorCode": "CODE_INVALID",
"message": "Verification code has expired was incorrect"
}{
"status": false,
"errorCode": "TOKEN_INVALID",
"message": "Security token does not match"
}{
"status": false,
"errorCode": "GENERAL_ERROR",
"message": "Something went wrong in your request. Failed to reset password"
}{
"status": false,
"errorCode": "VALIDATION_EXCEPTION",
"messages": {
"password": [
"The password confirmation does not match.",
"The password must be at least 8 characters."
]
}
}