registerUserBySocialInfo
Registers a new user account from the data collected during a social login and opens a session for it, using the registration token returned by socialNetworkLoginV2.
Documentation
Try it now
Request parameters:
Name | Description | Type | Values | Default |
|---|---|---|---|---|
socialRegistrationToken | The `registration.token` returned by `socialNetworkLoginV2`. It can be used only once and is rejected 10 minutes after it was issued | string | - | - |
email | Primary contact email address. When the social network supplied a verified email, submitting a different one is rejected; leave the field out to keep the provider value | string | - | - |
firstName | User's legal first name. Leave it out or send it empty to keep the value the social network supplied | string | - | - |
lastName | User's legal last name. Leave it out or send it empty to keep the value the social network supplied | string | - | - |
currency | The currency for the account | string | Currency | - |
languageCode | Preferred language code for communications | string | - | - |
language | Display language selected by the user | string | - | - |
city | The user's city of residence | string | - | - |
phone | User's phone number for contact or verification | string | - | - |
agree | Confirmation that the user agrees to the general terms | boolean | true / false | - |
siteId | The ID of the specific site/partner platform | number | - | - |
gender | The user's gender | string | Genders | - |
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 | - | - |
birthDate | User's date of birth | string | YYYY-MM-DD | - |
docNumber | Identity document number. Note: Uses personalId as fallback | string | - | - |
promoCode | Promotional code for offers or bonuses. It captures the B-Tag (Affiliate Tracking Tag) to link the new player to a specific marketing partner or referral source | string | - | - |
personalId | Personal identification number | string | - | - |
countryCode | ISO country code | string | "US", "GB", etc. | - |
incomeSource | Source of the user's income | string | - | - |
subscribeToSms | Whether the user agrees to receive SMS messages | boolean | true / false | - |
confirmationCode | Confirmation code sent via email or SMS | number | - | - |
subscribeToEmail | Whether the user agrees to receive promotional emails | boolean | true / false | - |
maxDailyBetAmount | Daily betting limit set by the user | number | - | - |
maxMonthlyBetAmount | Monthly betting limit set by the user | number | - | - |
subscribeToPhoneCall | Whether the user agrees to marketing calls | boolean | true / false | - |
maxSessionDurationDaily | Maximum daily session duration in hours. The SDK converts the value to minutes before sending it | number | - | - |
maxSessionDurationWeekly | Maximum weekly session duration in hours, tracked over a rolling 7-day period. The SDK converts the value to minutes before sending it | number | - | - |
maxSessionDurationMonthly | Maximum monthly session duration in hours. The SDK converts the value to minutes before sending it | number | - | - |
subscribeToInternalMessage | Agree to receive internal messages on the platform | boolean | true / false | - |
subscribeToPushNotification | Agree to receive push notifications | boolean | true / false | - |
btag | Affiliate or tracking tag for the user | number | - | - |
iban | User's International Bank Account Number | string | - | - |
title | User's title | string | - | - |
docType | Type of identification document provided by the user | number | - | - |
nickName | Optional nickname or display name for the user | string | - | - |
swiftCode | SWIFT/BIC code for international banking | string | - | - |
docIssuedBy | Authority or entity that issued the identification document | string | - | - |
mobilePhone | User's mobile phone number | string | - | - |
docIssueDate | Date the identification document was issued | string | - | - |
docIssueCode | Code of the authority that issued the document | string | - | - |
maxBetAmount | Maximum allowed bet amount for the user | number | - | - |
sessionSource | Source of the session | string | - | - |
additionalAddress | Suite, Apartment, or secondary address info | string | - | - |
subscribeToBonus | Whether the user agrees to receive bonuses and promotional offers | boolean | true / false | - |
activeTimeInCasino | Active time spent in the casino section | number | - | - |
newsletterSubscribe | Whether the user subscribes to the platform newsletter | boolean | true / false | - |
casinoMaximalDailyBet | Maximum allowed daily betting amount in the casino section | number | - | - |
casinoMaximalSingleBet | Maximum allowed single bet amount in the casino section | number | - | - |
isAutoWithdrawalEnabled | Whether automatic withdrawals are enabled for the user | boolean | true / false | - |
autoWithdrawalMinLeftAmount | Minimum remaining amount in the account after auto-withdrawal is triggered | number | - | - |
middleName | User's middle name (if applicable) | string | - | - |
citizenship | User's citizenship status | string | - | - |
address | Primary street address | string | - | - |
province | The user's province, state, or territory | string | - | - |
zipCode | Postal/Zip code | string | - | - |
telegramId | Optional Telegram integration ID | string | - | - |
bankAccount | It used to link a player's CPF-bound bank account, ensuring full traceability and preventing Money Laundering (AML). When the object is supplied, every field below must be present or the bank account is dropped from the request | object | - | |
└─ branch | The specific branch code or routing number associated with where the account was opened | number | - | - |
└─ bankId | A unique system identifier for the financial institution (often an internal ID or a swift/BIC-like code) | string | - | - |
└─ bankName | The full legal name of the bank | string | - | - |
└─ accountId | The actual bank account number or a unique tokenized identifier for the account | number | - | - |
└─ accountType | The category of account. A value outside this set is rejected before the request is sent | string | Account Types | - |
salary | User's income bracket | string | - | - |
balanceLimit | Maximum balance allowed on the account | number | - | - |
maxDayDeposit | Daily deposit ceiling | number | - | - |
hasMentalIllness | Safety flag for responsible gaming | boolean | true / false | - |
isSubscribeToCasinoSms | Specific opt-in for Casino-related SMS | boolean | true / false | - |
subscribeToNewsletter | General newsletter subscription | boolean | true / false | - |
locationToken | GeoComply token for location verification | string | - | - |
externalAuthToken | Token used for third-party authentication | string | - | - |
termsAcceptanceVersion | Records which version of T&C the user accepted | string | - | - |
termsAndConditionsVersion | Version of the Terms and Conditions the user accepted. Sent on the same wire field as termsAcceptanceVersion, which takes precedence when both are supplied | string | - | - |
identificationType | This field specifies the type of government-issued document used for mandatory identity verification | string | - | - |
confirmEmail | To re-enter their email address to ensure it matches the primary email field | string | - | - |
gRecaptchaResponse | This field is a Bot Mitigation token. It contains the encrypted payload generated by Google's reCAPTCHA service on the frontend. The backend uses this token to verify that the registration request was initiated by a real human and not an automated script or bot | string | - | - |
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 field is checked | string | 8 | - |
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 | - | - |
loyaltyCode | Tracks participation in specialized loyalty or retention programs | string | - | - |
accountHolder | This field stores the Full Legal Name of the bank account owner as it appears on official bank records | string | - | - |
referenceCode | This field is used for Specific Marketing Attribution. It captures a unique code (often provided via a referral link or a physical voucher) to link the player to a particular campaign, influencer, or partner | string | - | - |
occupation | This field captures the player's current profession or source of livelihood | string | - | - |
isSubscribeToCasinoPushNotification | This field captures the player's explicit, opt-in consent to receive marketing communications and promotional alerts specifically via browser or app push notifications | boolean | true / false | - |
birthRegion | This field records the specific province, state, or administrative region where the player was born | string | - | - |
maxMonthDeposit | This field defines the Monthly Financial Limit for the player | number | - | - |
isSubscribeToCasinoEmail | This field captures the player's explicit opt-in consent to receive marketing and promotional materials via email | boolean | true / false | - |
birthDepartment | This field captures the administrative district or department of the player's birth | string | - | - |
categoryId | This field facilitates the dynamic mapping of partner-specific labels to the core system's VIP (High-Value Client) status. Sent to the backend as partner_client_category_id | string | - | - |
maxWeeklyBetAmount | Weekly betting limit set by the user | number | - | - |
autoWithdrawalAmount | Automates "Winnings Protection" by moving excess funds out of the gaming environment | number | - | - |
isSubscribeToCasinoPhoneCall | This field captures the player's explicit opt-in consent to receive direct marketing communications via voice telephone calls | 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 | - |
maxYearDeposit | It represents the maximum total amount of money a user is permitted to deposit into their gaming account over a rolling 1 year period | number | - | - |
maxSingleDeposit | It restricts the amount a player can deposit in one go, regardless of their total daily or monthly limits | number | - | - |
maxWeekDeposit | This parameter defines the maximum cumulative amount a player can deposit into their account within a rolling 7-day period | number | - | - |
maxWeeklyDeposit | Weekly deposit ceiling, sent to the backend on the max_weekly_deposit field alongside maxWeekDeposit | number | - | - |
rfid | This field serves as the unique identifier for a physical Radio Frequency Identification (RFID) card or fob assigned to a player | string | - | - |
maximalMonthlyBet | This field defines the Monthly Turnover Limit for the player. It represents the maximum cumulative amount a user is permitted within a rolling 30-day period | number | - | - |
ipAddress | This field captures the Internet Protocol (IP) address of the device used by the player at the moment of registration or login | string | - | - |
betGiftCode | This field represents a unique social betting feature that allows a player to transfer an "unsettled" (active) bet to another individual | string | - | - |
fingerPrint | This field carries the Iovation Blackbox Hash, a sophisticated device identifier used to detect and prevent fraud during critical actions like registration and login | string | - | - |
docRegionId | This field is captures the unique identifier of the administrative region where the player's identity document was issued | string | - | - |
docRegionCode | This parameter specifies the Sub-national Region or State where a user's identification document was issued | string | - | - |
salaryMin | This field represents the player's lowest annual income | number | - | - |
salaryMax | This field represents the player's highest annual income | number | - | - |
bsn | This field captures the Dutch Citizen Service Number, a unique 9-digit personal identifier mandatory for all residents of the Netherlands | string | - | - |
birthCity | This field captures the official city of birth as stated on the player's government-issued identification | string | - | - |
birthName | This parameter captures the legal name of an individual at birth | string | - | - |
securityQuestion | This field is a composite security object containing a Question and its corresponding Answer | object | - | |
└─ question | This is the "Challenge." It is the text the user will be prompted to verify their identity with a support agent | string | - | - |
└─ answer | This is the "Secret." It is used to authorize an account recovery action | string | - | - |
docExpirationDate | This parameter specifies the expiry date of the user's identification document. | string | YYYY-MM-DD | - |
utmTag | This is a Marketing Attribution parameter used to track the origin of a player's registration | string | - | - |
cashDeskId | This parameter identifies a specific Physical Betting Shop or Retail Branch associated with a player's account | string | - | - |
bluemServiceIntegrationData | This is a Identity Verification Integration object specifically required for the Netherlands (KSA) market. iDIN allows players to verify their age and address through their own bank's secure environment before completing registration | object | - | |
└─ entranceCode | This is a security string generated by the iDIN provider. Sent to the backend as entrance_code | string | - | - |
└─ transactionId | This is the unique reference number for the specific identity check. Sent to the backend as transaction_id | string | - | - |
maxDailyLoss | This parameter allows a player to set a "cap" on the maximum amount to lose activities within a 24-hour window | number | - | - |
maxWeeklyLoss | This parameter allows a player to set a "cap" on the maximum amount to lose activities over a rolling 7-day period | number | - | - |
maxMouthlyLoss | This parameter allows a player to set a "cap" on the maximum amount to lose activities over a one-month period | number | - | - |
casinoMaxDailyLoss | The maximum net loss allowed on Casino games within a 24-hour period | number | - | - |
casinoMaxWeeklyLoss | The maximum net loss allowed on Casino games over a rolling 7-day period | number | - | - |
casinoMaxMonthlyLoss | The maximum net loss allowed on Casino games over a rolling 30-day period | number | - | - |
mitIdCode | This parameter is the OIDC Authorization Code generated by the Danish MitID service. In the Danish regulated market, this code is the mandatory link between a player's physical identity and their digital gambling account | 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 | - |
isSubscribeToCasinoBonus | This parameter is a Promotional Eligibility flag. It records whether a player specifically opts in to receive Casino-related bonus | boolean | true / false | - |
keepExternalLimits | This parameter allows a player to "transfer" or "keep" their existing monthly limit already registered in the LUGAS system from a previous operator, rather than forcing them to set a new manual limit during registration | boolean | true / false | - |
isNoPredefinedDepositLimit | This parameter is a Regulatory Choice flag that specifically addresses the requirement for players to explicitly choose whether or not they want to set financial boundaries during registration | boolean | true / false | - |
legitimuzInfoKey | This parameter is a Third-Party KYC Session Token specifically for the Brazilian (LATAM) market | string | - | - |
note | The note parameter is an optional string used to attach additional context, tracking information, or administrative remarks to a new user profile during the registration process | string | - | - |
position | The parameter is intended to capture the client's job title or rank | string | - | - |
experienceLevel | This parameter is used to store the player's Professional Industry. It acts as the second tier of the employment verification logic | string | - | - |
Parameters marked with must be included in the request
This method is usually used with these methods:
Call example:
registerUserBySocialInfo({
socialRegistrationToken: '3b7d0f4a9c2e4f8b8a6d1c5e7f9a2b4c',
email: '[email protected]',
firstName: 'John',
lastName: 'Doe',
currency: 'USD',
phone: '+37411223344',
countryCode: 'AM',
birthDate: '1990-04-17',
language: 'eng',
languageCode: 'en'
})Response examples:
{
code: 0,
hasError: false,
errorDetails: {
key: '',
message: ''
},
data: {
user_id: 132425153,
username: 'john.doe',
auth_token: 'a1d4f7c0e3b64f9a8c2d5e7f1b3a9c60',
can_login: true,
currency_name: 'USD',
is_new_client: true,
authentication_status: 1,
active_verification_step: 0
}
}Response parameters:
| Name | Description | Type | Values |
|---|---|---|---|
user_id | The unique User ID | number | - |
auth_token | Session token for the new player. Always returned on success — the account is registered and logged in by the same call | string | - |
username | The display name or login identifier generated for the account | string | - |
jwe_token | The JSON Web Encryption token | string | - |
can_login | A safety flag indicating if the account is currently permitted to access the platform | boolean | true / false |
currency_name | The currency associated with the user's wallet | string | - |
is_new_client | Whether the client was just created by this call | boolean | true / false |
status | Backend status code of the registration | number | - |
authentication_status | Verification status of the client | number | - |
active_verification_step | Indicates if there is a pending Know Your Customer (KYC) or security action required | number | - |
deposit_count | Number of deposits made. Always 0 for a freshly created account | number | - |
deposit_amount | Total deposited amount on the account. Always 0 for a freshly created account | number | - |
withdrawal_amount | Total withdrawn amount on the account. Always 0 for a freshly created account | number | - |
qr_code_origin | QR origin used to set up two-factor authentication | string | - |
needs_subscriptions_update | The client still has to confirm the subscription settings | boolean | true / false |