Xsolla-logo

Register new user

post/user

Creates a new user.

  • If you store user data at Xsolla or custom storage, the user will receive an account confirmation message.
  • If you store user data at PlayFab, the user will not receive an account confirmation message.

See the Comparison of user data storages page for more information about user data storages.

Request
query Parameters
projectId
required
string <uuid>

Login project ID from Publisher Account.

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. To find it, go to Login > your Login project > General settings. Required if there are several Callback URLs.

payload
string

Your custom data. The value of the parameter will be returned in the payload claim of the user JWT.

Request Body schema: application/json
username
required
string [ 1 .. 255 ] characters

Username.

password
required
string [ 6 .. 100 ] characters

User password.

email
required
string [ 1 .. 255 ] characters

User email address.

accept_consent
boolean

Whether the user gave consent to processing of their personal data.

fields
object

Parameters used for extended registration form. To use this feature, please contact your Account Manager.

promo_email_agreement
integer >= 0
Default: 1

User consent to receive the newsletter.

Enum: 0 1
Responses
200

OK (Account confirmation is disabled)

204

No Content (Account confirmation is enabled)

400

Bad Request

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/json
{
  • "email": "john-email@email.com",
  • "fields": {
    },
  • "password": "password123",
  • "username": "John"
}
Response samples
application/json