Admission

Admission Endpoints

This section will display all available endpoints to get admission data (Registration / Login).

Subsections of Admission

Registration Step One

This method creates an account for a player. The account is temporary and incomplete. If the player logs in to an incomplete account, they are automatically redirected to Registration Step two to complete their registration. use gateway.[msdomain] Parameter signOptOut required only for Malta or UK regulated brands

Request (POST)

/gateway/reg-step-one/{version}/{brand_id}

{
  "loginName": "string",
  "email": "string",
  "password": "stringst",
  "over18": true,
  "signTNC": true,
  "signOptOut": true,
  "language": "en",
  "btag": "string",
  "bonusCode": "string",
  "currency": "EUR",
  "aff_extra_param": "string"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
loginName body string true Player user name to login with, user will be considered as test account if it has ‘qqtst_’ prefix.
email body string true Player personal email.
password body string true Player password to login with.
over18 body boolean true Player confirmation he is over 18.
signTNC body boolean true Player confirmation he has read and accept TnC and Privacy policy.
signOptOut body boolean false Player notification if he does not want any notification via: chat/sms/chat.
language body string true Player chosen language, this will be the language player receives mails in.
btag body string true Affiliation system reference.
bonusCode body string false Promotion code which will determine bonuses to give.
currency body string true Player currency to use in site.

Response

Status 200 The response to a successful result contains an OK string with the auth_token that you need to use in the * Register Player - Step 2* call.

{
  "auth_token": "32fc6f4e-6a54-4807-8988-9911cb2aff92",
  "result": "OK",
  "player_id": 123
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "authToken": "null",
  "result": [
    {
      "field": "null",
      "errorCode": "Internal_server_error"
    }
  ]
}

The bonus code provided doesn’t exist in the system.

{
  "field": "bonusCode",
  "errorCode": "invalid_bonus_code"
}

If you receive a 422 error code for an Unprocessable Entity error, the client should not use the Message Format method to send a request to the server, but use its internal logic to present the message for one or more fields that didn’t pass the validation.

When a 422 validation error occurs, the response returns an array of one or more error codes detailing the fields that have validation errors. Multiple error messages are issued in the same validation form. The site should handle these validation errors and present a validation message to the player.

This will not call the message format.

The following table explains validation code behavior:

Field Error Code Description
loginName login_required A login name is required.
loginName login_already_exists A user with this name already exists.
loginName login_not_enough_char The user name must contain at least 6 characters.
loginName login_long the login name must not exceed 15 characters.
loginName login_invalid_char
email email_required An email address is required.
email email_syntax_error The email syntax is wrong. Format is aaa@bbb.ccc.
email email_fraud The mail domain will be checked against a fraud list (test players qqtst_ will not be checked).
email email_already_exists Email already exists.
password password_short The password is too short. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_long Password cannot exceed 15 characters.
password password_match_user_name Password must be different from the email and username.
password password_same_letters Password has too many repeating characters. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_mix_characters The password must have a combination of letters and digits.
bonusCode invalid_bonus_code The bonus code doesn’t exist in the system.
over18 over_18 The user didn’t mark the “over 18” field and/or sign the T&C.
currency currency_unknown The currency provided is unknown.
genericError generic_error The language provided is invalid.
{
  "auth_token": null,
  "result": [
    {
      "field": "loginName",
      "errorCode": "login_already_exists"
    },
    {
      "field": "email",
      "errorCode": "email_already_exists"
    },
    {
      "field": "currency",
      "errorCode": "currency_unknown"
    }
  ]
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
auth_token UUID to be used when sending registration step two request.
player_id unique id for the generated player.

Registration Step Two

This method completes the user registration process and makes the player’s account permanent.use gateway.[msdomain]

Request (POST)

/gateway/reg-step-two/{version}/{brand_id}

{
  "auth_token": "9deda661-7e8d",
  "firstName": "Firstname",
  "lastName": "Lastname",
  "birthDate": "01/01/1990",
  "gender": "M",
  "language": "en",
  "country": "HU",
  "city": "City",
  "address": "st. Somestreet, 10",
  "zipCode": "12345",
  "mobileNumber": "39-34535345",
  "uuid": "102d7d3834f4694ef00662"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
auth_token body string true Token received from step one result OR token received during login with incomplete registration status.
firstName body string true Player first name.
lastName body string true Player last name.
birthdate body boolean true Player date of birth, should be in format of: DD/MM/YYYY.
language body boolean true Language to use on site.
country body boolean true Player country.
city body string true Player city.
address body string true Player address.
zipCode body string true Player address zip postal code.
mobileNumber body string true Player mobile number, should contain country code prefix + number (XX-YYYYYY).
uuid body string true TMX validation param.

Response

Status 200 The response to a successful.

{
  "message": "",
  "result": "OK",
  "auth_token": "null",
  "authToken": "null"
}

Status 400

{
  "message": "malformed_request",
  "result": "malformed_request",
  "auth_token": "null",
  "authToken": "null"
}

Status 401.

{
  "message": "",
  "result": "malformed_token",
  "auth_token": "null",
  "authToken": "null"
}

Status 400.

{
  "result": "general_error"
}

If you receive a 422 error code for an Unprocessable Entity error, the client should not use the Message Format method to send a request to the server, but use its internal logic to present the message for one or more fields that didn’t pass the validation.

When a 422 validation error occurs, the response returns an array of one or more error codes detailing the fields that have validation errors. Multiple error messages are issued in the same validation form. The site should handle these validation errors and present a validation message to the player.

This will not call the message format.

The following table explains validation code behavior:

Field Error Code Description
firstName first_name_invalid Invalid characters in first name. This field accepts only letters and numbers.
lastName last_name_invalid Invalid characters in last name. This field accepts only letters and numbers.
birthDate birth_date_required Birth date empty.
birthDate birth_date_invalid Birth date is not valid (31.2).
birthDate birth_date_over18 Player must be over 18.
gender gender_required Gender field empty.
language language_required Invalid language.
country country_required Country field empty.
address address_invalid Address format not valid.
mobileNumber mobile_required User didn’t provide a mobile number.
mobileNumber mobile_invalid Mobile number contains invalid characters.
{
  "message": "",
  "result": [
    {
      "field": "firstName",
      "errorCode": "first_name_invalid",
      "result": "",
      "status": "422"
    }
  ],
  "auth_token": "null",
  "authToken": "null"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
auth_token UUID to be used when sending registration step two requst.
player_id unique id for the generated player.

Email and Password Registration

This method creates an player account while providing minimal information.

Request (POST)

/gateway/email-and-pass-reg/{version}/{brand_id}

The following call uses same but it is deprecated: /gateway/short-reg/{version}/{brand_id}

{
  "email": "string",
  "password": "stringst",
  "over18": true,
  "signTNC": true,
  "language": "en",
  "bonusCode": "string",
  "btag": "string",
  "uuid": "102d7d3834f4694ef00662"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
email body string true Player personal email.
password body string true Player password to login with.
over18 body boolean true Player confirmation he is over 18.
signTNC body boolean true Player confirmation he has read and accept TnC and Privacy policy.
language body string true Player chosen language, this will be the language player receives mails in.
btag body string true Affiliation system reference.
bonusCode body string false Promotion code which will determine bonuses to give.
currency body string true Player currency to use in site.

Response

Status 200

{
  "message": "",
  "result": "OK",
  "auth_token": "token123",
  "authToken": null,
  "player_id": 123
}

Status 400

{
  "message": "malformed_request",
  "result": "malformed_request",
  "auth_token": "null",
  "authToken": "null"
}

Status 401

{
  "message": "",
  "result": "malformed_token",
  "auth_token": "null",
  "authToken": "null"
}

The bonus code provided doesn’t exist in the system.

{
  "field": "bonusCode",
  "errorCode": "invalid_bonus_code"
}

If you receive a 422 error code for an Unprocessable Entity error, the client should not use the Message Format method to send a request to the server, but use its internal logic to present the message for one or more fields that didn’t pass the validation.

When a 422 validation error occurs, the response returns an array of one or more error codes detailing the fields that have validation errors. Multiple error messages are issued in the same validation form. The site should handle these validation errors and present a validation message to the player.

This will not call the message format.

The following table explains validation code behavior:

Field Error Code Description
loginName login_required A login name is required.
loginName login_already_exists A user with this name already exists.
loginName login_not_enough_char The user name must contain at least 6 characters.
loginName login_long the login name must not exceed 15 characters.
loginName login_invalid_char
email email_required An email address is required.
email email_syntax_error The email syntax is wrong. Format is aaa@bbb.ccc.
email email_fraud The mail domain will be checked against a fraud list (test players qqtst_ will not be checked).
email email_already_exists Email already exists.
password password_short The password is too short. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_long Password cannot exceed 15 characters.
password password_match_user_name Password must be different from the email and username.
password password_same_letters Password has too many repeating characters. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_mix_characters The password must have a combination of letters and digits.
bonusCode invalid_bonus_code The bonus code doesn’t exist in the system.
over18 over_18 The user didn’t mark the “over 18” field and/or sign the T&C.
currency currency_unknown The currency provided is unknown.
genericError generic_error The language provided is invalid.
{
  "auth_token": null,
  "result": [
    {
      "field": "loginName",
      "errorCode": "login_already_exists"
    },
    {
      "field": "email",
      "errorCode": "email_already_exists"
    },
    {
      "field": "currency",
      "errorCode": "currency_unknown"
    }
  ]
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
auth_token UUID to be used when sending registration step two requst.
player_id unique id for the generated player.

Basic Details Registration

This method creates an player account while providing minimal information.

Request (POST)

/gateway/basic-details-reg/{version}/{brand_id}

The following call uses same but it is deprecated: /gateway/extended-short-reg/{version}/{brand_id}

{
  "loginName": "string",
  "password": "stringst",
  "email": "string",
  "over18": true,
  "signTNC": true,
  "language": "en",
  "currency": "EUR",
  "bonusCode": "string",
  "btag": "string",
  "uuid": "102d7d3834f4694ef00662"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
loginName body string true Player user name to login with, user will be considered as test account if it has ‘qqtst_’ prefix.
email body string true Player personal email.
password body string true Player password to login with.
over18 body boolean true Player confirmation he is over 18.
signTNC body boolean true Player confirmation he has read and accept TnC and Privacy policy.
language body string true Player chosen language, this will be the language player receives mails in.
btag body string true Affiliation system reference.
bonusCode body string false Promotion code which will determine bonuses to give.
currency body string true Player currency to use in site.

Response

Status 200

{
  "message": "",
  "result": "OK",
  "auth_token": "token123",
  "authToken": null,
  "player_id": 123
}

Status 400

{
  "message": "malformed_request",
  "result": "malformed_request",
  "auth_token": "null",
  "authToken": "null"
}

Status 401

{
  "message": "",
  "result": "malformed_token",
  "auth_token": "null",
  "authToken": "null"
}

The bonus code provided doesn’t exist in the system.

{
  "field": "bonusCode",
  "errorCode": "invalid_bonus_code"
}

If you receive a 422 error code for an Unprocessable Entity error, the client should not use the Message Format method to send a request to the server, but use its internal logic to present the message for one or more fields that didn’t pass the validation.

When a 422 validation error occurs, the response returns an array of one or more error codes detailing the fields that have validation errors. Multiple error messages are issued in the same validation form. The site should handle these validation errors and present a validation message to the player.

This will not call the message format.

The following table explains validation code behavior:

Field Error Code Description
loginName login_required A login name is required.
loginName login_already_exists A user with this name already exists.
loginName login_not_enough_char The user name must contain at least 6 characters.
loginName login_long the login name must not exceed 15 characters.
loginName login_invalid_char
email email_required An email address is required.
email email_syntax_error The email syntax is wrong. Format is aaa@bbb.ccc.
email email_fraud The mail domain will be checked against a fraud list (test players qqtst_ will not be checked).
email email_already_exists Email already exists.
password password_short The password is too short. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_long Password cannot exceed 15 characters.
password password_match_user_name Password must be different from the email and username.
password password_same_letters Password has too many repeating characters. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_mix_characters The password must have a combination of letters and digits.
bonusCode invalid_bonus_code The bonus code doesn’t exist in the system.
over18 over_18 The user didn’t mark the “over 18” field and/or sign the T&C.
currency currency_unknown The currency provided is unknown.
genericError generic_error The language provided is invalid.
{
  "auth_token": null,
  "result": [
    {
      "field": "loginName",
      "errorCode": "login_already_exists"
    },
    {
      "field": "email",
      "errorCode": "email_already_exists"
    },
    {
      "field": "currency",
      "errorCode": "currency_unknown"
    }
  ]
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
auth_token UUID to be used when sending registration step two requst.
player_id unique id for the generated player.

Login

This method logs in player to site, and returns a token to be used in all other methods. use gateway.[msdomain]

Request (POST)

/gateway/login/{version}/{brand_id}/player

{
  "user_name": "string",
  "email": "string",
  "password": "string",
  "language": "string",
  "brand_id": "string"
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
user_name body string false Player user name to login with, if not sent, email will be used.
email body string false Player personal email, if user_name is not sent, email will be used as the user name.
password body string true Player password to login with.
language body string true Player chosen language, this will be the language player receives mails in.
2fa-auth-token header string false Player 2FA Auth token that was given when the Player turned on the 2FA requirement in the account page

Response

Status 200

{
  "auth_token": "e74af034-a346-4d5c-be97-f7ed83f373a7",
  "result": "OK",
  "actions": [
    "responsible_gaming",
    "limits",
    "deposit_message",
    "self_exclusion",
    "timeout",
    " account_closure",
    "swap_limits",
    "start_game",
    "wallet",
    "login",
    "KYC"
  ],
  "documents_required": true,
  "identification_token": "214fecab65a7031b8530d4d000f3aa8b",
  "links": {
    "get_crm_token": "/gateway/crm/{version}/{brand_id}/token"
  }
}

Status 303

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail.

Response notes:

  • documents_required indicates if the player must upload KYC documents now. when true, identification_token contains a UUID (otherwise empty string).
  • For INCOMPLETE_REGISTRATION and EMAIL_NOT_VERIFIED it’s always false because these occur before KYC is needed; a true value for them cannot occur logically.

Example 1 — INCOMPLETE_REGISTRATION (no documents required)

{
  "token": "e74af034-a346-4d5c-be97-f7ed83f373a7",
  "result": "INCOMPLETE_REGISTRATION",
  "actions": [
    "responsible_gaming",
    "limits",
    "deposit_message",
    "self_exclusion",
    "timeout",
    "account_closure",
    "swap_limits",
    "start_game",
    "wallet",
    "login"
  ],
  "documents_required": false,
  "identification_token": ""
}

Example 2 — TNC_APPROVAL_REQUIRED (documents required)

{
  "token": "e74af034-a346-4d5c-be97-f7ed83f373a7",
  "result": "TNC_APPROVAL_REQUIRED",
  "actions": [
    "responsible_gaming",
    "limits",
    "deposit_message",
    "self_exclusion",
    "timeout",
    "account_closure",
    "swap_limits",
    "start_game",
    "wallet",
    "KYC",
    "login"
  ],
  "documents_required": true,
  "identification_token": "214fecab65a7031b8530d4d000f3aa8b"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

Error Code Description
USER_PASSWORD_NOT_VALID Credentials entered do not match any player in system.
EXCEEDED_MAX_LOGIN_ATTEMPTS To many login attempts made in short period, need to wait few minutes till next try, till then, player will be considered as ‘Blocked’.
BANNED_COUNTRY Login country is forbidden.
PLAYER_BLOCKED Player cannot login, he is blocked.
IP_BLOCKED IP has been black listed in system.
{
  "result": "USER_PASSWORD_NOT_VALID"
}

Status 401 (Player need to verify his mobile number)

{
  "status": "mobile_verification_required",
  "data": {
    "mobile_number": "****1234",
    "2fa_auth_token": "60a6bbc8-95a3-4b4f-8305-cb334cc975b1"
  }
}

Status 401 (Player need to verify his mobile number)

{
  "status": "sms_verification_required",
  "data": {
    "mobile_number": "****1234",
    "2fa_auth_token": "60a6bbc8-95a3-4b4f-8305-cb334cc975b1"
  }
}

Status 401 (Need to wait before sending SMS code again)

{
  "status": "LOGIN_IN_PROCESS",
  "data": {
    "description": "Please wait before sending again in 52 seconds",
    "remaining_time": 52
  }
}

Status 401 (Player is blocked due to missing KYC documents)

{
  "result": "PLAYER_BLOCKED",
  "actions": [
    "responsible_gaming",
    "limits",
    "deposit_message",
    "self_exclusion",
    "timeout",
    "account_closure",
    "swap_limits",
    "start_game",
    "wallet",
    "KYC",
    "login"
  ],
  "documents_required": true,
  "identification_token": "214fecab65a7031b8530d4d000f3aa8b"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
token UUID which should be used as x-auth-token during player login time on each action he performs on site.
actions List containing all regulation requirements.

Logout

This method will be used to logout player from site. use gateway.[msdomain]

Request (POST)

/gateway/logout/{version}/{brand_id}/player

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player session to logout.

Response

Status 200

{
  "result": "successful logout"
}

Status 303

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail.
{
  "token": "e74af034-a346-4d5c-be97-f7ed83f373a7",
  "result": "INCOMPLETE_REGISTRATION",
  "actions": [
    "responsible_gaming",
    "limits",
    "deposit_message",
    "self_exclusion",
    "timeout",
    "account_closure",
    "swap_limits",
    "start_game",
    " wallet",
    "login"
  ]
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Keep Alive

This method extends player session in site. use gateway.[msdomain]

Request (POST)

/gateway/login/keep-alive/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true Player session.

Response

Status 204

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 400

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Get Crm Token

This method gets the crm token of the player

Request (Get)

/gateway/crm/{version}/{brand_id}/token

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string true The token the player got from the Login response

Response

Status 200

{
  "status": "Success",
  "data": {
    "token": "e94187765acfe001e415107c68f6a6fd5e74b66042145fe28609787b2e881b67",
    "expire_time": "2024-08-27T16:50:16+02:00" 
  }
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "token header is missing"
}

Status 500

{
  "result": "internal server error"
}

Test User Registration

This method creates an account for a player. The account is temporary and incomplete. If the player logs in to an incomplete account, they are automatically redirected to step 2 to complete their registration. use gateway.[msdomain] Parameter signOptOut required only for Malta or UK regulated brands

Request (POST)

/gateway/registration-test-user/{version}/{brand_id}

{
  "emailVerified": true,
  "withdrawalAllowedDepositAllowed": true,
  "bonusOptOut": 0,
  "userBlocked": true,
  "operator": "string",
  "stepOne": {
    "loginName": "string",
    "email": "string",
    "password": "stringst",
    "over18": true,
    "signTNC": true,
    "signOptOut": true,
    "language": "en",
    "btag": "string",
    "bonusCode": "string",
    "currency": "EUR",
    "aff_extra_param": "string"
  },
  "stepTwo": {
    "auth_token": "string",
    "firstName": "string",
    "lastName": "string",
    "birthDate": "string",
    "gender": "string",
    "language": "en",
    "country": "string",
    "city": "string",
    "address": "string",
    "zipCode": "string",
    "mobileNumber": "39-34535345",
    "uuid": "string"
  }
}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
emailVerified body string true Indication if to set email as verified or not.
withdrawalAllowedDepositAllowed body string true Indication if the player can deposit/withdraw.
bonusOptOut body string true Indication if the player can accept bonuses or not.
userBlocked body string true Indication if the player will be blocked.
stepOne.loginName body string true Player chosen username for site.
stepOne.email body string true Player personal email.
stepOne.password body string true Player password to login with.
stepOne.over18 body boolean true Player confirmation he is over 18.
stepOne.signTNC body boolean true Player confirmation he has read and accept TnC and Privacy policy.
stepOne.signOptOut body boolean false Player notification if he does not want any notification via: chat/sms/chat.
stepOne.language body string true Player chosen language, this will be the language player receives mails in.
stepOne.btag body string true Affiliation system reference.
stepOne.bonusCode body string false Promotion code which will determine bonuses to give.
stepOne.currency body string true Player currency to use in site.
stepTwo.firstName body string true Player first name.
stepTwo.lastName body string true Player last name.
stepTwo.birthdate body boolean true Player date of birth, should be in format of: DD/MM/YYYY.
stepTwo.language body boolean true Language to use on site.
stepTwo.country body boolean true Player country.
stepTwo.city body string true Player city.
stepTwo.address body string true Player address.
stepTwo.zipCode body string true Player address zip postal code.
stepTwo.mobileNumber body string true Player mobile number, should contain country code prefix + number (XX-YYYYYY).
stepTwo.uuid body string true TMX validation param.

Response

Status 200 The response to a successful result contains an OK string with the auth_token that you need to use in the * Register Player - Step 2* call.

{
  "auth_token": "32fc6f4e-6a54-4807-8988-9911cb2aff92",
  "result": "OK"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "authToken": "null",
  "result": [
    {
      "field": "null",
      "errorCode": "Internal_server_error"
    }
  ]
}

The bonus code provided doesn’t exist in the system.

{
  "field": "bonusCode",
  "errorCode": "invalid_bonus_code"
}

If you receive a 422 error code for an Unprocessable Entity error, the client should not use the Message Format method to send a request to the server, but use its internal logic to present the message for one or more fields that didn’t pass the validation.

When a 422 validation error occurs, the response returns an array of one or more error codes detailing the fields that have validation errors. Multiple error messages are issued in the same validation form. The site should handle these validation errors and present a validation message to the player.

This will not call the message format.

The following table explains validation code behavior:

Field Error Code Description
loginName login_required A login name is required.
loginName login_already_exists A user with this name already exists.
loginName login_not_enough_char The user name must contain at least 6 characters.
loginName login_long the login name must not exceed 15 characters.
loginName login_invalid_char
email email_required An email address is required.
email email_syntax_error The email syntax is wrong. Format is aaa@bbb.ccc.
email email_fraud The mail domain will be checked against a fraud list (test players qqtst_ will not be checked).
email email_already_exists Email already exists.
password password_short The password is too short. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_long Password cannot exceed 15 characters.
password password_match_user_name Password must be different from the email and username.
password password_same_letters Password has too many repeating characters. It must have at least 8 characters, including a combination of digits and letters. It should also contain at least 4 different characters.
password password_mix_characters The password must have a combination of letters and digits.
bonusCode invalid_bonus_code The bonus code doesn’t exist in the system.
over18 over_18 The user didn’t mark the “over 18” field and/or sign the T&C.
currency currency_unknown The currency provided is unknown.
genericError generic_error The language provided is invalid.
{
  "auth_token": null,
  "result": [
    {
      "field": "loginName",
      "errorCode": "login_already_exists"
    },
    {
      "field": "email",
      "errorCode": "email_already_exists"
    },
    {
      "field": "currency",
      "errorCode": "currency_unknown"
    }
  ]
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
auth_token UUID to be used when sending registration step two requst.