Personal Data

Personal Data Endpoints

This section will display all available endpoints to get personal data.

Subsections of Personal Data

Personal Details

This method returns the details for a player. Use this method to open your own personal details page for a user to update the user. use gateway.[msdomain]

Request (GET)

/gateway/player-personal-details/player/details/{version}/{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 login session.

Response

Status 200

{
  "firstName": "playerName",
  "lastName": "playerLastname",
  "birthdate": "1996-11-02 00:00:00",
  "gender": "F",
  "language": "en",
  "country": "AD",
  "city": "playerCity",
  "address": "playerAddress",
  "zipPostalCode": "1111",
  "phone": "countrycode-phonenumber",
  "eMail": {
    "eMailAdress": "playermael@domain.com",
    "isVerified": true
  },
  "optOut": {
    "chat": false,
    "sms": false,
    "email": true,
    "phone": true
  },
  "is2faRequired": true,
  "mobileVerificationStatus": 0,
  "mobileVerificationStatusDate": "2022-01-01 00:00:00",
  "mobileVerificationStatusChangedBy": "system",
  "pendingMobileNumber": "555-111111"
}

Status 400

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

Status 401

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

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
firstName Player first name.
lastName Player last name.
birthdate Player date of birth.
gender Player gender (F/M).
language Player emailing language.
country Player country.
city Player city.
address Player address.
zipPostalCode Player zip code.
phone Player mobile number.
eMail.emailAddress Player email address.
eMail.isVerified Player email address verification status.
optOut.chat Indication if player requested to not get contacted in chat.
optOut.sms Indication if player requested to not get contacted in sms.
optOut.email Indication if player requested to not get contacted in email.
optOut.phone Indication if player requested to not get contacted in phone.
is2faRequired Indication if player has set is account to require 2fa.
mobileVerificationStatus Indication if player has confirmed his mobile number.
mobileVerificationStatusDate Indication when player has confirmed his mobile number.
mobileVerificationStatusChangedBy Indication who confirmed his mobile number.
pendingMobileNumber Player phone number pending verification.

Request (PUT)

/gateway/player-personal-details/player/details/{version}/{brand_id}

Parameters:

{
  "lastName": "last",
  "firstName": "last",
  "birthdate": "2000-01-01",
  "gender": "M",
  "language": "en",
  "country": "IL",
  "city": "city",
  "address": "address",
  "zipPostalCode": "123123123",
  "phone": "12-1231231",
  "comment": "comment",
  "operator": "Player",
  "optOut": "{\"chat\": false}"
}
Name In Type Required Description
version path string true The API version to use.
brand_id path string 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 login session.
lastName body string false Player new last name.
firstName body string false Player new first name.
birthdate body string false Player new birthdate (format YYYY-MM-DD).
gender body string false Player new gender (F/M).
country body string false Player new country.
city body string false Player new city.
address body string false Player new address.
zipPostalCode body string false Player new zip code.
phone body string false Player new mobile number.
optOut.sms body bool false Player new sms opt out status.
optOut.chat body bool false Player new chat opt out status.
optOut.email body bool false Player new email opt out status.
optOut.phone body bool false Player new phone opt out status.

Response

Status 204 (No Content)

Status 400

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

Status 400

{
  "errMsg": "invalid input"
}

Status 401

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

Status 403 (When trying to update mobile number while verification is enabled - 2fa/verification)

{
  "status": "mobile_verification_required",
  "data": {
    "mobile_number": "09a21de0-a6c2-11ed-94a8-8a19e0bf9728",
    "2fa_auth_token": "221-34535345"
  }
}

Status 404

{
  "errMsg": "Player Personal Details not found"
}

Status 500

{
  "result": "internal server error"
}

Custom Fields

This method returns the details for a player. Use this method to open your own personal details page for a user to update the user. use gateway.[msdomain]

Request (GET)

/gateway/player-personal-details/{version}/custom-fields/{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 unique login session id.

Response

Status 200

{
  "strCustomFields": [
    {
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "intCustomFields": [
    {
      "id": "string",
      "name": "string",
      "value": 0
    }
  ]
}

Status 400

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

Status 401

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

Status 500

{
  "result": "internal server error"
}

Request (PUT)

/gateway/player-personal-details/{version}/custom-fields/{brand_id}

Parameters:

{
  "strCustomFields": [
    {
      "id": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "intCustomFields": [
    {
      "id": "string",
      "name": "string",
      "value": 0
    }
  ]
}

Response

Status 200

{
  "result": "success"
}

Status 400

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

Status 400

{
  "errMsg": "invalid input"
}

Status 401

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

Status 500

{
  "result": "internal server error"
}

Update Player Email

This method updates a player’s email address.

The new email address is placed in a pending status until the player verifies it. The system sends a verification email that contains a verificaton link to the player’s new and old email addresses. use gateway.[msdomain]

Request (POST)

/gateway/player-personal-details/player/details/emailUpdate/{version}/{brand_id}

{
  "email": "aaa@aaa.com",
  "comment": "test"
}

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 login session.
eMail body string true Player new email.
comment body string false Comment to insert during update, if not set, default is: player request.

Response

Status 204 (No content)

Status 400

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

Status 401

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

Status 404

{
  "errMsg": "Player Personal Email not found"
}

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
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.
email email_long Email to long.
email invalid_email Email entered is invalid. 
{
  "result": [
    {
      "field": "email",
      "errorCode": "invalid_email"
    }
  ]
}

Status 500

{
  "result": "internal server error"
}

Forgot Password

This method sends a password reset email to a player. use gateway.[msdomain]

Request (POST)

/gateway/admission/{version}/forgot/password/{brand_id}

Parameters:

{
  "mail": "string"
}
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.
mail body string true player email to send a link for reset password to.

Response

Status 201

{
  "message_format": "forgot_email_sent"
}

Status 400

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

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
message_format Message format to be displayed taken from Message Format.

Verify Password

This method sends a password reset email to a player. use gateway.[msdomain]

Request (PUT)

/gateway/admission/{version}/verify/password/{brand_id}

Parameters:

{
  "new_password": "string"
}
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.
hash query string true unique hash to identify request.
new_password body string true Player request for new password.

Response

Status 200

{
  "message_format": "password_successfully_changed"
}

Status 202

{
  "token": "sdfsdf-sdfsdf-sdf-sdf-sdf",
  "message_format": "password_successfully_changed"
}

Status 400

{
  "message_format": "general_failure"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
message_format Message format to be displayed taken from Message Format.
token Login session to be used for following calls, if token returns and not empty, that means login process was successful.

Change Password

This method sends a password reset email to a player. use gateway.[msdomain]

Request (PUT)

/gateway/admission/{version}/player/{brand_id}/change/password

Parameters:

{
  "old_password": "string",
  "new_password": "string"
}
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 login session.
old_password body string true player old password for verification.
new_password body string true player new password.

Response

Status 202

{
  "message_format": "password_replaced"
}

Status 303

{
  "“message_format”": "“tnc_approval_required”"
}

Status 400

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

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
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.
password wrong_old_password The verification password entered is not valid. 
{
  "message_format": "wrong_old_password"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
message_format Message format to be displayed taken from Message Format.

Resend Activation Email

This method send activation email to player for email verification. use gateway.[msdomain]

Request (PUT)

/gateway/admission/{version}/resend/activation/email/{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 login session.

Response

{
  "msg": "Activation Email was sent."
}

Status 400

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

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
msg Successful message.

Sign TnC

This method indicates that the user has signed the T&C. use gateway.[msdomain] Need to call this method once player approves the T&C. Error regarding approval required will be returned if player has not signed the T&C Or Privacy Policy. Error can be returned from the following endpoints:

  1. Login
  2. Get Payment Methods
  3. Start Game
  4. Get Player Status
  5. Get Player Info

Request (POST)

/gateway/player/multi/{version}/sign/tnc

Parameters:

Name In Type Required Description
version path string true The API version to use.
x-auth-token header string true Player login session.
brand_id body string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
player_id body string true Player unique ID.
language body string true Player current language on site.
type body string true One of the following: tnc/privacy, will indicate on what the player has signed.

Response

Status 201

successfully signed TNC

Status 303, in case of player needs to sign both TnC and Privacy Policy, on first approval of TnC, the response will be:

{
  "sign: ": [
    "privacy_policy"
  ]
}

Status 400

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

Status 500

{
  "result": "internal server error"
}

Online Player Status

This method returns data about an online player. use gateway.[msdomain]

Request (GET)

/gateway/online-player/{version}/player/{brand_id}/online/status

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string 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 login session.

Response

Status 200

{
  "marketingSegmentation": "10",
  "tag_status": 100,
  "deposit_count": 1,
  "vip_level": "Bronze",
  "average_deposit": 44,
  "billboard": "",
  "segmentation_id": 1,
  "maxBalance": 93604,
  "UT": 1,
  "decline": "0",
  "VIP_segment": 1,
  "total_balance": 936.04,
  "pending_withdrawal": 44,
  "total_withdrawals": 0,
  "last_bet": "2022-01-01 00:00:01",
  "last_deposit": "2022-01-01 00:00:01",
  "last_deposit_amount": 44,
  "rounds_since_login": 0,
  "balance_since_login": 0,
  "playerIdLink": "https://cbo2.aaa.com/players/123456789",
  "bonusOptOut": 0,
  "real_balance": 906.04,
  "freeTraffic": false,
  "depositsAmount": 44,
  "chat_opt_out": false,
  "bonusBalance": 30.0,
  "maxWin": 12.0,
  "wageringBalance": 1540.12,
  "wageringComplete": ""
}

Status 303, in case of reality check enabled for player and time has passed

{
  "currency": "EUR",
  "profit": 10,
  "total_bets": 200,
  "total_wins": 300,
  "total_lossed": 0,
  "restart_period": "15_min",
  "time_played": "1 hour 15 minutes",
  "min": "15",
  "h": "1"
}

Status 400

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

401 Response, in case of some addition requirement needed before proceeding

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. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

401 Response

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

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
marketingSegmentation player marketing segmentation.
vip_level player vip level.
VIP_segment player vip segmentation.
total_balance current player balance (including bonuses).
lastBet player last time of wager.
lastDeposit player last time of deposit.
realBalance player real money in balance
bonusBalance player bonus money in balance
wageringBalance player remaining wagering money
wageringComplete indication if player has recently had wagering completed event (0/1)
maxWin wagering complete max win of bonuses which had wagering completion
wageringCompleteInfoPath path for wagering complete event details, need to add gateway domain for request - gateway.[msdomain], format will be: ‘/gateway/bonus/{version}/wagering-complete/{brand_id}/{player_id}/{unique_ref_id}’
is_missing_player_details indication if player has missing details, need to ask to fill details before deposit call

Online Player Info

This method returns data about an online player. use gateway.[msdomain]

Request (GET)

/gateway/online-player/{version}/{brand_id}/player/info

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string 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 login session.

Response

Status 200

{
  "playerID": {
    "username": "itamar1",
    "ID": 33003139,
    "brand": 1
  },
  "firstName": "nadya",
  "lastName": "mag",
  "gender": "F",
  "email": "itamar1@me.com",
  "vip_level": 1,
  "country": "IT",
  "test_account": 0,
  "currencyName": "EUR",
  "currencySymbol": "€",
  "bTag": "PQ4YXsO2q5kWqcfzu"
}

Status 400

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

401 Response, in case of some addition requirement needed before proceeding

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. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

401 Response

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

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
playerID.ID player unique ID in system.

Player Status During Game

This method returns data about an online player. use gateway.[msdomain]

Request (GET)

/gateway/online-player/{version}/player/{brand_id}/online/ingame/status/{game_session_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
game_session_id path string true Unique session ID provider by start game request.

Response

Status 200

{
  "marketingSegmentation": "10",
  "tag_status": 100,
  "deposit_count": 1,
  "vip_level": "Bronze",
  "average_deposit": 44,
  "billboard": "",
  "segmentation_id": 1,
  "maxBalance": 93604,
  "UT": 1,
  "decline": "0",
  "VIP_segment": 1,
  "total_balance": 936.04,
  "pending_withdrawal": 44,
  "total_withdrawals": 0,
  "last_bet": "2022-01-01 00:00:01",
  "last_deposit": "2022-01-01 00:00:01",
  "last_deposit_amount": 44,
  "rounds_since_login": 0,
  "balance_since_login": 0,
  "playerIdLink": "https://cbo2.aaa.com/players/123456789",
  "bonusOptOut": 0,
  "real_balance": 906.04,
  "freeTraffic": false,
  "depositsAmount": 44,
  "chat_opt_out": false
}

Status 303, in case of reality check enabled for player and time has passed

{
  "currency": "EUR",
  "profit": 10,
  "restart_period": "15_min",
  "time_played": "1 hour 15 minutes",
  "min": "15",
  "h": "1"
}

Status 400

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

401 Response, in case of some addition requirement needed before proceeding

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. 
{
  "result": "INCOMPLETE_REGISTRATION"
}

401 Response

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

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
marketingSegmentation player marketing segmentation.
vip_level player vip level.
VIP_segment player vip segmentation.
total_balance current player balance (including bonuses).
last_bet player last time of wager.
last_deposit player last time of deposit.
real_balance player real money in balance