/pre-register

✅ Email as user_id

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

Response code

Error

Message

Scenario

Resolution

201 Created

uuid value

Successful response

201 Created

uuid value

Successful resending of activation link

201 Created

uuid value

Successful pre-registration with missing locale

201 Created

uuid value

Missing grant_type value

201 Created

uuid value

Successful pre-registration with empty locale

201 Created

uuid value

Successful pre-register when grant_type is invalid

201 Created

uuid' value

Successful pre-register when resend value is invalid

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.

422 Unprocessable Entity

invalid_form_fields

"emailAddress": [
"Email address is already is use."
]

"error_description": "some inputs are invalid"

Error on pre-registration of existing email

Enter a valid email address that hasn't been registered.

422 Unprocessable Entity

invalid_form_fields

"emailAddress": [
"Email address is already is use."
]

"error_description": "some inputs are invalid"

Error on pre-registration of existing email when resend is false

Enter a valid email address that hasn't been registered.

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

"profile_fields": "field required"

Removed profile_fields parameter

Add the profile_fields parameter and value.

422 Unprocessable Entity

invalid_parameters

"emailAddress": {
"missing": "required"
}

no error description

Removed emailAddress parameter

Add the emailAddress parameter and value.

422 Unprocessable Entity

invalid_parameters

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

no error description

Missing client_id value

Enter the client_id 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": null,
"error_description": "Missing Parameter: redirect_uri"

Missing redirect_uri value

Enter a valid "redirect_uri` value.

422 Unprocessable Entity

invalid_parameters

"emailAddress": {
"missing": "required"
}

no error description

Missing profile_fields value

Enter a valid profile_fields value.

422 Unprocessable Entity

invalid_parameters

Example:

"380": "Expecting value: line xx column xx (char 380)

Missing resend value

Enter a valid resend value.

422 Unprocessable Entity

invalid_parameters

"user_id": {
"missing": "required"
}

no error description

Missing emailAddress value

Enter a valid `emailAddress 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

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

invalid_parameters

"emailAddress": [
""Email address is not formatted correctly."
]

"error_description": "some inputs are invalid"

Invalid emailAddress value

Enter a valid emailAddress value.

422 Unprocessable Entity

unexpected_error

"error_details": null,
"error_description": "could not find a flow 'standard_global" with version "20220207155201304965' and locale 'xxxx' "

Invalid locale value

Enter a valid locale value.

✅ Mobile phone number as user_id

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

Response code

Error

Message

Scenario

Resolution

Successful pre-registration

uuid value

Error when resend parameter is true

uuid value

Error when grant_type is empty

uuid value

Successful sending when resend is true

invalid_form_fields

"mobilePrimary": [
"Mobile phone is already in use"

"error_description": "some inputs are invalid"

Error when mobile number exist

Enter a mobile phone number that is not registered yet.

invalid_form_fields

"mobilePrimary": [
"Mobile phone is already in use"

"error_description": "some inputs are invalid"

Error when resend parameter is false

Enter a mobile phone number that is not registered yet.

invalid_parameters

"auth_type": "field required"

Removed auth_type parameter

Add the auth_type parameter and value.

invalid_parameters

"redirect_uri": "field required"

Removed redirect_uri parameter

Add the redirect_uri parameter and value.

invalid_parameters

"grant_type": "field required"

Removed grant_type parameter

Add the grant_type parameter and value.

invalid_parameters

"profile_fields": "field required"

Removed profile_fields parameter

Add the profile_fields parameter and value.

422 Unprocessable Entity

invalid_parameters

"mobilePrimary": {
"missing": "required"
}

no error description

Removed mobilePrimary parameter

Add the mobilePrimary 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

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

Missing redirect_uri value

Enter a valid redirect_uri value.

422 Unprocessable Entity

invalid_parameters

"mobilePrimary": {
"missing": "required"
}

no error description

Missing mobilePrimary value

Enter a valid `mobilePrimary 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

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

no error description

Invalid redirect_uri value

Enter a valid redirect_uri value.

422 Unprocessable Entity

unexpected_error

Example:

"error_details": null,
"error_description": "could not find a flow named 'standard_global' with version '20220207155201304965' and locale 'xxxx' "

Invalid locale value

Enter a valid locale value.

422 Unprocessable Entity

invalid_form_fields

"mobilePrimary": [
"Mobile phone is already in use"
]

"error_description": "some inputs are invalid"

Existing mobilePrimary value and resend value is false

Enter a mobilePrimary value that is not registered yet.

422 Unprocessable Entity

invalid_form_fields

"mobilePrimary": [
"Mobile phone is already in use"
]

"error_description": "some inputs are invalid"

Existing mobilePrimary value

Enter a mobilePrimary value that is not registered yet.

502 Bad Gateway

Invalid mobilePrimary value

Enter a valid mobilePrimary value.