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