Next ReasonNext Reason CareersNext Identity Status

Forgot Password

/forgot-password

✅ Email as user_id

These are the possible response codes when you make an API call to the /forgot-password endpoint with an email address as user_id.

Response codeErrorMessageScenarioResolution
-getaddrinfo ENOTFOUND"Could not send request"Invalid environment URLEnter the correct environment ID.
200 OK--Send user forgot password link by email address-
200 OK--Invalid grant_type value-
200 OK--Removed grant_type parameter-
200 OK--Removed locale value-
400 Bad Requesthttp_exception"Invalid json format"Empty payloadAdd the payload.
400 Bad Requestinvalid_parameters"Invalid json format"Invalid JSON format used in the payload.Use correct JSON format for the payload.
400 Bad RequestInvalid_domain"Invalid API usage"Invalid environment ID in URLEnter the correct environment ID in the URL.
403 Forbiddenhttp_exception"Forbidden"Invalid client_id valueEnter a valid client_id value.
422 Unprocessable Entityinvalid_parameters"client_id": {
"missing": "required"
}

no error description		Missing client_id valueEnter a valid client_id value.
422 Unprocessable Entityinvalid_parameters"client_id": "field required"Removed client_id parameterAdd the client_id parameter and value.
422 Unprocessable Entityinvalid_parameters"auth_type": {
"invalid": "unsupported auth_type value"
}

no error description		Invalid auth_type valueEnter a valid auth_type value.
422 Unprocessable Entityinvalid_parameters"auth_type": {
"invalid": "unsupported auth_type value"
}

no error description		Missing auth_type valueEnter a valid auth_type value.
422 Unprocessable Entityinvalid_parameters"auth_type": "field required"Removed auth_type parameterAdd the auth_type parameter and value
422 Unprocessable Entityinvalid_parameters"redirect_uri": {
"invalid": "invalid value"
}

no error description		Invalid redirect_uri valueEnter a valid redirect_uri value
422 Unprocessable Entityhttp_exception"error_details": null,
"error_description": "missing_argument Missing Parameter: redirect_uri"		Missing redirect_uri valueEnter a valid redirect_uri value
422 Unprocessable Entityinvalid_parameters"redirect_uri": "field required"Remove redirect_uri parameterAdd the redirect_uri parameter and value.
422 Unprocessable Entityinvalid_parameters"user_id": {
"invalid": "invalid format"
}

no error description		Invalid user_id value.Enter a valid user_id value.
422 Unprocessable Entityinvalid_parameters"user_id": {
"invalid": "invalid format"
}

no error description		Missing user_id value.Enter a valid user_id value.
422 Unprocessable Entityinvalid_parameters"user_id": "field required"Removed user_id parameterAdd the user_id parameter and value.
422 Unprocessable Entityhttp_exceptionExample:

"error_details": null,
"error_description": "unexpected_error could not find a flow named 'standard_global' with version '20220128140831839568' and locale 'xx'"		Invalid locale valueEnter a valid locale value.
503 Service Temporary Unavailable--Invalid region value in URLEnter a valid region value.

✅ Mobile phone number as user_id

These are the possible response codes when you make an API call to the /forgot-password endpoint with a mobile phone number as user_id.

Response codeErrorMessageScenarioResolution
-getaddrinfo ENOTFOUND"Could not send request"Invalid environment URLEnter a valid environment URL
200 OK-verification code sent to mobile phone numberSend user forgot password link by mobile phone number-
200 OK--Invalid auth_type-
200 OK--Null value in redirect_uri-
200 OK-code sent to mobile phone numberInvalid grant_type value-
200 OK-code sent to mobile phone numberNull value for grant_type-
200 OK-code sent to mobile phone numberChange password to PIN-
200 OK-code sent to mobile phone numberNull for locale value-
200 OK-code sent to mobile phone numberRemove locale parameter-
400 Bad Requestinvalid_domain"message": "Invalid API usage"Invalid environment ID valueEnter a valid environment ID value.
403 Forbiddenhttp_exception"Forbidden"Invalid client_id valueEnter a valid client_id value.
422 Unprocessable Entityinvalid_parameters"client_id": {
"missing": "required"
}

no error description		Missing in client_id valueEnter a valid client_id value.
422 Unprocessable Entityinvalid_parameters"client_id": "field required"Remove client_id parameterAdd the client_id parameter and value.
422 Unprocessable Entityinvalid_parameters"auth_type": {
"invalid": "unsupported auth_type value"
}

no error description		Missing auth_type valueEnter a valid auth_type value.
422 Unprocessable Entityinvalid_parameters"auth_type": "field required"Removed auth_type parameterAdd the auth_type parameter and value.
422 Unprocessable Entityinvalid_parameters"redirect_uri": {
"invalid": "invalid value"
}

no error description		Invalid redirect_uriEnter a valid redirect_uri value.
422 Unprocessable Entityinvalid_parameters"redirect_uri": "field required"Removed redirect_uri parameterAdd the redirect_uri parameter and value.
422 Unprocessable Entityinvalid_parameters"user_id": {
"invalid": "invalid format"
}

no error description		Invalid user_id or mobile number valueEnter a valid user_id value.
422 Unprocessable Entityinvalid_parameters"user_id": "field required"Removed user_id or mobile number valueAdd the user_id parameter and value.
502 Bad Gateway--Invalid locale valueEnter a valid locale value.
503 Service Temporarily Unavailable-"Backend action does not exist"Invalid version code in URLEnter a valid version code in the URL.