Request a password reset

A user can provide a new confirmed password.

Email route

/password/reset/?token={TOKEN}&email={EMAIL}

{warning} Route above, delivered in the email must be catched by the frontend system and call the endpoint below to complete the password recovery.


Method Uri Auth Permissions
POST /v1/auth/password/reset none none

Headers

The API requires a header Accept to be submitted with the request:

{
    "Accept": "application/json"
}

Data constraints

{
  "token": "required",
  "email": "required|email",
  "password": "required|confirmed",
  "password_confirmation": "required"
}

Success Responses

Condition : A valid token, email and passwords have been provided

Code : 200 Okay

{
  "message": "Your password has been reset!"
}

Error Responses

Condition : If data is not complete.

Code : 422 Unprocessable Entity

Content example :

{
  "message": "De opgegeven informatie bevat fouten.",
  "errors": {
    "token": [
      "The token field is required."
    ]
  }
}

Condition : If token is invalid.

Code : 422 Unprocessable Entity

Content example :

{
  "message": "De opgegeven informatie bevat fouten.",
  "errors": {
    "email": [
      "This password reset token is invalid."
    ]
  }
}