| | | | |
id | The unique identifier for the user | number | - | - |
iban | International Bank Account Number of the user | number | - | - |
city | The current city where the user resides | string | - | - |
phone | The user's verified mobile or landline number with country code | string | - | - |
email | The primary contact and login email address | string | - | - |
zipCode | The postal or ZIP code | string | - | - |
gender | The user's gender | string | "M", "F", "G" | - |
userName | The unique handle for the user. Must be unique across the system. This is typically used for login and public-facing profile identification | string | - | - |
address | The primary residential street address | string | - | - |
password | User’s chosen password for login | string | - | - |
lastName | The user's legal surname/family name | string | - | - |
firstName | The user's legal first name | string | - | - |
birthDate | The user's date of birth (Format: YYYY-MM-DD). Used for age verification | string | YYYY-MM-DD | - |
docNumber | The identification number of the user's passport or national ID card | string | - | - |
swiftCode | SWIFT/BIC code for international bank transfers | string | - | - |
birthCity | City where the user was born | string | - | - |
personalId | Government-issued personal identification number | string | - | - |
countryCode | The user's current residence country. The code ISO uppercase code | string | "AM", "RU", "US", etc. | - |
birthRegion | This field records the specific province, state, or administrative region where the player was born | string | - | - |
subscribeToSms | Whether the user agrees to receive SMS messages | boolean | true / false | - |
birthDepartment | This field captures the administrative district or department of the player's birth | string | "RE", "RM", "VE", "RO", etc. | - |
clientPepStatus | This field captures the player's self-declaration regarding their status as a Politically Exposed Person (PEP). It is a mandatory requirement for AML (Anti-Money Laundering) compliance in Poland. Front should allow only one value "8", if the filed is checked | string | - | 8 |
subscribeToEmail | Whether the user agrees to receive promotional emails | boolean | true / false | - |
confirmationCode | Confirmation code sent via email or SMS | string | - | - |
additionalAddress | Secondary or complementary address information | string | - | - |
subscribeToPhoneCall | Whether the user agrees to marketing calls | boolean | true / false | - |
subscribeToInternalMessage | Agree to receive internal messages on the platform | boolean | true / false | - |
subscribeToPushNotification | Agree to receive push notifications | boolean | true / false | - |
personalId | Specifically used for the Polish market. Mapped to personal_id, it represents the national 11-digit identification number | string | - | - |
birthCountry | This field identifies the user's country of birth | string | "AM", "FR", etc. | - |
accountHolder | This field stores the Full Legal Name of the bank account owner as it appears on official bank records | string | - | - |
mobilePhone | The user's primary mobile contact number | string | - | - |
subscribedToNews | Determines whether the user receives marketing updates, newsletters, and promotional content | boolean | true / false | - |
middleName | User's middle name (if applicable) | string | - | - |
currency | The preferred currency for the user. Must be a 3-letter ISO | string | "AMD", "RUB", "USD" | - |
token | The active session or authentication token | string | - | - |
subscribeToBonus | Whether the user agrees to receive bonuses and promotional offers | boolean | true / false | - |
activeTimeInCasino | Total cumulative time the user has spent in the casino interface | boolean | true / false | - |
title | User's title | string | - | - |
nickName | The display name shown to other users | string | - | - |
maxBetAmount | Maximum allowed bet amount for the user | number | - | - |
maxDailyBetAmount | Daily betting limit set by the user | number | - | - |
isTwoFactorAuthenticationEnabled | To enable Two-Factor Authentication (2FA) for the account | boolean | true / false | - |
partnerClientCategoryId | This field facilitates the dynamic mapping of partner-specific labels to the core system's VIP (High-Value Client) status | string | - | - |
province | The user's province, state, or territory | string | - | - |
affiliateId | This field is used for Attribution and Source Tracking. It links a new player registration to a specific licensed marketing partner (affiliate) to track the effectiveness of acquisition campaigns | string | - | - |
cashDeskId | This parameter identifies a specific Physical Betting Shop or Retail Branch associated with a player’s account | string | - | - |
citizenship | User's citizenship status | string | - | - |
clientId | A unique identifier for the specific client application or platform instance | string | - | - |
isSubscribeToCasinoNewsletter | This parameter is explicitly records whether a player has opted in to receive promotional content specifically related to Casino products | boolean | true / false | - |
isSubscribeToCasinoEmail | This field captures the player's explicit opt-in consent to receive marketing and promotional materials via email | boolean | true / false | - |
isSubscribeToCasinoSms | Specific opt-in for Casino-related SMS | boolean | true / false | - |
isSubscribeToCasinoBonus | This parameter is a Promotional Eligibility flag. It records whether a player specifically opts in to receive Casino-related bonus | boolean | true / false | - |
isSubscribeToCasinoInternalMessage | This field captures the player’s explicit opt-in consent to receive marketing and promotional notifications through the internal platform inbox | boolean | true / false | - |
isSubscribeToCasinoPhoneCall | This field captures the player's explicit opt-in consent to receive direct marketing communications via voice telephone calls | boolean | true / false | - |
isSubscribeToDirectMail | To manage the user's consent for direct mail marketing. Set to true to opt-in for physical/direct promotional materials, or false to opt-out | boolean | true / false | - |