/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 code

Error

Message

Scenario

Resolution

getaddrinfo ENOTFOUND

"Could not send request"

Invalid environment URL

Enter 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 Request

http_exception

"Invalid json format"

Empty payload

Add the payload.

400 Bad Request

invalid_parameters

"Invalid json format"

Invalid JSON format used in the payload.

Use correct JSON format for the payload.

400 Bad Request

Invalid_domain

"Invalid API usage"

Invalid environment ID in URL

Enter the correct environment ID in the URL.

403 Forbidden

http_exception

"Forbidden"

Invalid client_id value

Enter a valid client_id value.

422 Unprocessable Entity

invalid_parameters

"client_id": {
"missing": "required"
}

no error description

Missing client_id value

Enter a valid client_id value.

422 Unprocessable Entity

invalid_parameters

"client_id": "field required"

Removed client_id parameter

Add the client_id parameter and value.

422 Unprocessable Entity

invalid_parameters

"auth_type": {
"invalid": "unsupported auth_type value"
}

no error description

Invalid auth_type value

Enter a valid auth_type value.

422 Unprocessable Entity

invalid_parameters

"auth_type": {
"invalid": "unsupported auth_type value"
}

no error description

Missing auth_type value

Enter a valid auth_type value.

422 Unprocessable Entity

invalid_parameters

"auth_type": "field required"

Removed auth_type parameter

Add the auth_type parameter and value

422 Unprocessable Entity

invalid_parameters

"redirect_uri": {
"invalid": "invalid value"
}

no error description

Invalid redirect_uri value

Enter a valid redirect_uri value

422 Unprocessable Entity

http_exception

"error_details": null,
"error_description": "missing_argument Missing Parameter: redirect_uri"

Missing redirect_uri value

Enter a valid redirect_uri value

422 Unprocessable Entity

invalid_parameters

"redirect_uri": "field required"

Remove redirect_uri parameter

Add the redirect_uri parameter and value.

422 Unprocessable Entity

invalid_parameters

"user_id": {
"invalid": "invalid format"
}

no error description

Invalid user_id value.

Enter a valid user_id value.

422 Unprocessable Entity

invalid_parameters

"user_id": {
"invalid": "invalid format"
}

no error description

Missing user_id value.

Enter a valid user_id value.

422 Unprocessable Entity

invalid_parameters

"user_id": "field required"

Removed user_id parameter

Add the user_id parameter and value.

422 Unprocessable Entity

http_exception

Example:

"error_details": null,
"error_description": "unexpected_error could not find a flow named 'standard_global' with version '20220128140831839568' and locale 'xx'"

Invalid locale value

Enter a valid locale value.

503 Service Temporary Unavailable

Invalid region value in URL

Enter 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 code

Error

Message

Scenario

Resolution

getaddrinfo ENOTFOUND

"Could not send request"

Invalid environment URL

Enter a valid environment URL

200 OK

verification code sent to mobile phone number

Send 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 number

Invalid grant_type value

200 OK

code sent to mobile phone number

Null value for grant_type

200 OK

code sent to mobile phone number

Change password to PIN

200 OK

code sent to mobile phone number

Null for locale value

200 OK

code sent to mobile phone number

Remove locale parameter

400 Bad Request

invalid_domain

"message": "Invalid API usage"

Invalid environment ID value

Enter a valid environment ID value.

403 Forbidden

http_exception

"Forbidden"

Invalid client_id value

Enter a valid client_id value.

422 Unprocessable Entity

invalid_parameters

"client_id": {
"missing": "required"
}

no error description

Missing in client_id value

Enter a valid client_id value.

422 Unprocessable Entity

invalid_parameters

"client_id": "field required"

Remove client_id parameter

Add the client_id parameter and value.

422 Unprocessable Entity

invalid_parameters

"auth_type": {
"invalid": "unsupported auth_type value"
}

no error description

Missing auth_type value

Enter a valid auth_type value.

422 Unprocessable Entity

invalid_parameters

"auth_type": "field required"

Removed auth_type parameter

Add the auth_type parameter and value.

422 Unprocessable Entity

invalid_parameters

"redirect_uri": {
"invalid": "invalid value"
}

no error description

Invalid redirect_uri

Enter a valid redirect_uri value.

422 Unprocessable Entity

invalid_parameters

"redirect_uri": "field required"

Removed redirect_uri parameter

Add the redirect_uri parameter and value.

422 Unprocessable Entity

invalid_parameters

"user_id": {
"invalid": "invalid format"
}

no error description

Invalid user_id or mobile number value

Enter a valid user_id value.

422 Unprocessable Entity

invalid_parameters

"user_id": "field required"

Removed user_id or mobile number value

Add the user_id parameter and value.

502 Bad Gateway

Invalid locale value

Enter a valid locale value.

503 Service Temporarily Unavailable

"Backend action does not exist"

Invalid version code in URL

Enter a valid version code in the URL.