/
v3.0.11Get access

subscribeToUserProfile

This method provides a real-time stream of the authenticated user's account data. It is the primary mechanism for keeping the user interface synchronized with the backend, pushing immediate updates whenever there are changes to the user's balance, verification status, or loyalty progress.

Request parameters:

The method works without parameters

Call example:

subscribeToUserProfile()

Response examples:

{
  response: {
    subid: '-4337637404705657385',
    data: {
      profile: {
        '335140210': {
          id: 3210,
          _parent_id: null,
          unique_id: 335140210,
          username: '5491355',
          name: 'Al Rams',
          first_name: 'Al',
          last_name: 'Rams',
          middle_name: null,
          gender: 'M',
          email: '[email protected]',
          phone: '5511934491355',
          reg_info_incomplete: false,
          address: 'Rua Padre Capra',
          reg_date: '2025-10-13',
          birth_date: '1999-01-01',
          doc_number: '224343223',
          casino_promo: null,
          currency: 'BRL',
          currency_id: 'BRL',
          currency_name: 'BRL',
          balance: 687.52,
          casino_balance: null,
          exclude_date: null,
          bonus_id: -1,
          games: 0,
          _level: 'profile',
          super_bet: null,
          country_code: 'ZW',
          doc_issued_by: null,
          doc_issue_date: null,
          doc_issue_code: null,
          province: null,
          iban: null,
          active_step: null,
          active_step_state: null,
          subscribed_to_news: false,
          bonus_balance: 0,
          frozen_balance: 0,
          bonus_win_balance: 0,
          city: 'Santo André',
          has_free_bets: false,
          loyalty_point: 196.52,
          loyalty_earned_points: 0,
          loyalty_exchanged_points: 0,
          loyalty_level_id: 44821,
          affiliate_id: null,
          is_verified: true,
          incorrect_fields: null,
          loyalty_point_usage_period: 0,
          loyalty_min_exchange_point: 0,
          loyalty_max_exchange_point: 0,
          active_time_in_casino: 0,
          last_read_message: null,
          unread_count: 0,
          last_login_date: 1776171954,
          swift_code: null,
          counter_offer_min_amount: 100,
          sportsbook_profile_id: 5,
          subscribe_to_email: true,
          subscribe_to_sms: true,
          subscribe_to_bonus: true,
          is_tax_applicable: false,
          nem_id_token: null,
          mobile_phone: null,
          personal_id: '82394241047',
          zip_code: '09030060',
          additional_address: null,
          btag: null,
          birth_region: null,
          supported_currencies: null,
          wallets: null,
          previous_login_time: null,
          nick_name: null,
          is_super_bet_available: true,
          is_gdpr_passed: false,
          subscribe_to_internal_message: true,
          subscribe_to_push_notification: true,
          subscribe_to_phone_call: true,
          title: null,
          terms_and_conditions_version: 'sigap_v1',
          terms_and_conditions_acceptance_date: '2025-10-13',
          last_preferred_currency: null,
          is_agent: false,
          is_two_factor_authentication_enabled: false,
          authentication_status: 0,
          qr_code_origin: null,
          session_duration: 30,
          is_new_client: null,
          unplayed_balance: 0,
          language: 'pb',
          exclude_type: null,
          is_bonus_allowed: true,
          casino_bonus: 0,
          casino_bonus_win: 0,
          birth_city: null,
          client_pep_status: 0,
          cashdesk_id: null,
          last_sport_bet_time: 1774731699,
          sport_bonus: 0,
          is_phone_verified: false,
          is_mobile_phone_verified: false,
          limit_check_state: null,
          deposit_count: 1,
          bonus_money: 0,
          loyalty_last_earned_points: 0,
          is_cash_out_available: true,
          doc_region_id: 0,
          last_login_ip: '91.103.58.245',
          status: 2,
          is_email_verified: false,
          loyalty_level_name: '5',
          last_deposit_time: 1764744310,
          is_resident: false,
          is_subscribe_to_casino_news_letter: true,
          is_subscribe_to_casino_email: true,
          is_subscribe_to_casino_sms: true,
          is_subscribe_to_casino_bonus: true,
          is_subscribe_to_casino_internal_message: true,
          is_subscribe_to_casino_push_notification: true,
          is_subscribe_to_casino_phone_call: true,
          is_subscribe_to_direct_mail: true,
          needs_subscriptions_update: false,
          first_deposit_time: 1764744310,
          last_deposit_amount: 1,
          last_withdrawal_amount: 50,
          last_withdrawal_time: 1765177083,
          deposit_amount: 1,
          withdrawal_amount: 50
        }
      }
    },
    hasError: false,
    error: '',
    rid: 62676494
  }
}

Response parameters:

NameDescriptionTypeValues
id
The internal unique identifier for the player.number-
btag
Tracking tag used for marketing attribution.string-
username
The unique login credential for the user.string-
zip_code
Postal code for the user's address.string-
owner_id
The unique identifier of the parent entity or agent that "owns" the user account within the platform's hierarchy.number-
status
Current account statenumber-
unique_id
The internal unique identifier for the player.number-
gender
Biological gender code (e.g., "M", "F").string-
product_id
A numeric code identifying the specific gaming vertical (e.g., Sportsbook, Casino, Poker) the user is currently interacting with.number-
name
User's full display name.string-
city
User's city of residence.string-
currency
The primary base currency for the partner.string-
currency_id
String identifier for the currency.string-
active_step
Current step in a multi-stage process (e.g., KYC).number-
address
User's registered street address.string-
country_code
ISO code of the user's registered country (e.g., "ZW").string-
phone
Primary contact phone number string.string-
reg_date
Date the account was created (YYYY-MM-DD).string-
last_name
User's last namestring-
email
User's email addressstring-
loyalty_point
Total points available for exchange/redemption.number-
first_name
User's first namestring-
birth_date
User's birth datestring-
bonus_money
Bonus money amountnumber-
sport_bonus
Sports bonus amountnumber-
middle_name
User's middle namestring-
balance
User's account balancenumber-
swift_code
SWIFT/BIC code for bank transfers.string-
casino_bonus
Current active casino bonus amount.number-
deposit_count
Number of depositsnumber-
loyalty_level_id
Loyalty level IDnumber-
currency_name
Full name/code of the currency.string-
bonus_balance
Bonus balance amountnumber-
birthDepartment
Department of birthstring-
birth_city
City of birth (optional)string-
casino_balance
Casino balance amountnumber-
frozen_balance
Frozen balance amountnumber-
unread_count
Count of unread messagesnumber-
iban
International Bank Account Numberstring-
birth_region
Region of birth (optional)string-
unplayed_balance
Unplayed balance amountnumber-
active_step_state
State of the active stepnumber-
sportsbook_profile_id
Sportsbook profile IDnumber-
last_login_date
Last login date (timestamp)number-
casino_bonus_win
Winnings from casino bonusnumber-
loyalty_level_name
Name of the loyalty levelstring-
is_verified
Indicates if the user is verifiedbooleantrue / false
birth_department
Department of birth (optional)string-
has_free_bets
Indicates if the user has free betsbooleantrue / false
bonus_win_balance
Balance of winnings from bonusesnumber-
personal_id
Personal ID (can be number or string)string-
loyalty_earned_points
Total loyalty points earnednumber-
partner_client_category_id
Partner client category IDnumber-
last_deposit_time
Time of the last deposit (timestamp)number-
loyalty_exchanged_points
Total loyalty points exchangednumber-
is_cash_out_available
Indicates if cash out is availablebooleantrue / false
is_super_bet_available
Indicates if super bet is availablebooleantrue / false
counter_offer_min_amount
Minimum amount for a counter offernumber-
additional_address
Additional address information (optional)string-
is_phone_verified
Indicates if the user's phone is verifiedbooleantrue / false
client_pep_status
Politically Exposed Person status (optional)string-
is_ekeng_verified
Indicates if the user is verified via Ekengbooleantrue / false
doc_number
Document number (can be number or string, optional)string-
is_bonus_allowed
Indicates if bonuses are allowed for the userbooleantrue / false
subscribed_to_news
Indicates if the user is subscribed to newsbooleantrue / false
terms_and_conditions_version
Version of accepted terms and conditionsstring-
reg_info_incomplete
Indicates if registration information is incompletebooleantrue / false
terms_and_conditions_acceptance_date
Date of terms and conditions acceptancestring-
subscribe_to_sms
Indicates if the user is subscribed to SMS notifications (optional)booleantrue / false
is_two_factor_authentication_enabled
Indicates if two-factor authentication is enabledbooleantrue / false
subscribe_to_email
Indicates if the user is subscribed to email notifications (optional)booleantrue / false
is_subscribe_to_casino_phone_call
Indicates if the user is subscribed to casino phone callsbooleantrue / false
subscribe_to_internal_message
Indicates if the user is subscribed to internal messages (optional)booleantrue / false
subscribe_to_phone_call
Indicates if the user is subscribed to phone call notifications (optional)booleantrue / false
subscribe_to_push_notification
Indicates if the user is subscribed to push notifications (optional)booleantrue / false
is_subscribe_to_casino_internal_message
Indicates if the user is subscribed to casino internal messagesbooleantrue / false
is_subscribe_to_casino_push_notification
Indicates if the user is subscribed to casino push notificationsbooleantrue / false
bet_settlement
Object with properties: state (number) - settlement state; win_amount (number | null) - winning amount or nullobject
super_bet
SuperBet object with properties: super_bet_id (number) - super bet unique identifier; super_bet_status (number) - super bet status codeobject
loyalty_min_exchange_point
The minimum points required to start an exchangenumber-
loyalty_max_exchange_point
The maximum points allowed for a single exchangenumber-
loyalty_point_usage_period
The duration or expiration rules for pointsnumber-
loyalty_last_earned_points
Points generated from the most recent activity.number-
active_time_in_casino
Total duration of casino gameplay session.number-
last_read_message
Tracking ID or timestamp for the user's inbox.number-
last_login_ip
The IP address used during the last session.string-
first_deposit_time
Timestamp (unix) of the user's initial deposit.number-
last_deposit_amount
The value of the most recent deposit.number-
last_withdrawal_amount
The value of the most recent withdrawal.number-
last_withdrawal_time
Timestamp (unix) of the most recent withdrawal.number-
deposit_amount
Cumulative total amount depositednumber-
withdrawal_amount
Cumulative total amount withdrawnnumber-
last_sport_bet_time
Timestamp (unix) of the most recent sportsbook wagernumber-
is_tax_applicable
Boolean indicating if tax deductions apply to this profilebooleantrue / false
is_resident
Boolean for tax residency status.booleantrue / false
is_agent
Flag indicating if the user has agent/affiliate permissions.booleantrue / false
is_gdpr_passed
Status of data privacy consentbooleantrue / false
is_mobile_phone_verified
Specific verification flag for mobile devices (distinct from is_phone_verified)booleantrue / false
language
The user’s selected language code (e.g., "pb").string-
session_duration
Default time (minutes) before an automatic logout.number-
authentication_status
Numeric code representing the current login/2FA state.number-
limit_check_state
Responsible gaming limit statusnumber-
needs_subscriptions_update
System flag asking the user to refresh their marketing consentsbooleantrue / false
is_using_loyalty_program
It tells whether the player is enrolled in the partner's loyalty program. It is a boolean. It is true when the player is enrolled, false when not, and null when the platform does not report the flag for that partner. booleantrue / false