/register

✅ Email as user_id

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

Response code

Error

Message

Scenario

Resolution

200 OK

uuid value

Register valid email address with expected values

200 OK

"An email has been sent to the address on record"

Register email address twice

It did not duplicate the user record because it did not show UUID.

200 OK

uuid value

Invalid scope_id

200 OK

uuid value

Missing scope_id

200 OK

uuid value

Removed scope_id parameter

200 OK

uuid value

Invalid grant_type parameter

200 OK

uuid value

Missing grant_type parameter

200 OK

uuid value

Missing locale value

200 OK

uuid value

Removed locale value parameter

200 OK

uuid value

Invalid site_identifier

200 OK

uuid value

Missing site_identifier

200 OK

uuid value

Removed site_identifier

200 OK

authorization_code

newPassword in not a required in client configuration settngs, and removed from payload

200 OK

uuid value`

newPassword is required in client configuration settngs, and available in payload

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.

403 Forbidden error

http_exception

Forbidden

Invalid client_id value

Enter a valid client_id value.

422 Unprocessable Entity

invalid_form_fields

"emailAddress": [
"Email address is not formatted correctly."
]
"error_description": "some inputs are invalid"

Register an invalid email address

Use a valid and properly formatted email address.

422 Unprocessable Entity

invalid_parameters

"error_details": {
"newPassword, newPasswordConfirm": {
"unexpected_keys": "Unexpected parameters found in the request."
}
},

no error description

newPassword is not required in client configuration settings, and available in the payload

Remove the newPassword profile field.

422 Unprocessable Entity

invalid_parameters

"error_details": {
"newPassword": {
"missing": "required"
},
"newPasswordConfirm": {
"missing: "required"
}
}
no error description

newPassword is required in client configuration settings, but not available in the payload

Add the missing newPassword value in the profile fields.

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

"error_details": {
"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

"error_details": {
"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

missing_argument

Missing Parameter: redirect_uri

Missing invalid redirect_uri value

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

"error_details": {
"grant_type":"field required"
}

Removed grant_type parameter

Add the grant_type parameter and value.

422 Unprocessable Entity

invalid_parameters

"displayName": {
"unexpected_keys": "Unexpected parameters found in the request."
}

no error description

Add additional field that is not part of profile_fields or forms configuration

Use parameters that are allowed in the forms configuration.

422 Unprocessable Entity89

unexpected_error

could not find a flow named 'standard_global' with version 'xxxxxx" and locale 'xx-xxx'

Invalid locale value

Enter a valid locale value.

422 Unprocessable Entity

invalid_parameters

"error_details": {
"475":"Expecting value: line xx column xx (char xxx)"
}

Invalid value for legal_acceptances

Enter a valid value for legal_acceptances parameter.

422 Unprocessable Entity

invalid_parameters

"The Legal Acceptances were updated, you must accept before continuing"

no error description

The legal_acceptances parameter is set to false.

Set the correct value for the legal_acceptances parameter.

503

Service Temporarily Unavailable

Backend action does not exist

Invalid version code

Use a valid version code.

✅ Mobile as user_id

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

Response code

Error

Message

Scenario

Resolution

200 OK

uuid value

Register mobile number with expected values

200 OK

An SMS has been sent to the address on record

Register mobile number twice

200 OK

uuid value

Invalid scope_id

200 OK

uuid value

Missing scope_id

200 OK

uuid value

Remove scope_id parameter

200 OK

uuid value

Invalid grant_type parameter

200 OK

uuid value

Missing grant_type parameter

200 OK

uuid value

Missing locale value

200 OK

uuid value

Removed locale value parameter

200 OK

uuid value

Invalid site_indentifier

200 OK

uuid value

Missing site_indentifier

200 OK

uuid value

Removed site_indentifier

200 OK

authorization_code

newPassword in not a required in client configuration settngs, and removed from payload

200 OK

uuid value

newPassword is required in client configuration settngs, and available in payload

403 Forbidden

http_exception

"Forbidden"

Invalid client_id value

Enter a valid client_id value.

422 Unprocessable Entity

invalid_parameters

"error_details": {
"newPassword, newPasswordConfirm": {
"unexpected_keys": "Unexpected parameters found in the request."
}
},

no error description

newPassword is not required in client configuration settings, and available in the payload

Remove the newPassword profile field.

422 Unprocessable Entity

invalid_parameters

"error_details": {
"newPassword": {
"missing": "required"
},
"newPasswordConfirm": {
"missing: "required"
}
}
no error description

newPassword is required in client configuration settings, but not available in the payload

Add the missing newPassword value in the profile fields.

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"

no error description

Removed client_id parameter

Add the client_id parameter and value.

422 Unprocessable Entity

invalid_parameters

"invalid":"unsupported auth_type value"

no error description

Invalid auth_type value

Enter a valid auth_type value.

422 Unprocessable Entity

invalid_parameters

"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"

Remove auth_type parameter

Add the auth_type parameter and value.

422 Unprocessable Entity

invalid_parameters

"invalid":"invalid value"

no error description

Invalid redirect_uri value

Enter a valid redirect_uri value.

422 Unprocessable Entity

missing_argument

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

Missing redirect_uri value

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

"grant_type": "field required"

Removed grant_type parameter

Add the grant_type parameter and value.

422 Unprocessable Entity

invalid_parameters

"displayName": {
"unexpected_keys": "Unexpected parameters found in the request."

no error description

Add additional field that is not part of profile_fields or forms config

Use parameters that are allowed in the forms configuration.

422 Unprocessable Entity

unexpected_error

"could not find a flow named "standard_global" with version 'xxxxxxx" and locale "xx-xxx""

Invalid locale value

Enter a valid locale value.

422 Unprocessable Entity

invalid_parameters

"454": "Expecting ',' delimiter: line xx column xx (char xxx)"

Invalid value for legal_acceptances parameter

Enter a valid value for legal_acceptances parameter.

422 Unprocessable Entity

invalid_parameters

"message": "The Legal Acceptances were updated, you must accept before continuing"

no error description

The legal_acceptances parameter is set to false.

Set the correct value for the legal_acceptances parameter.

502

Bad Gateway

Register invalid mobile number

Use a valid mobile phone number.

503

Service Temporarily Unavailable

Backend action does not exist

Invalid version code

Enter a valid version code.