login

This request authenticates the user and returns an object with authentication token, below see corresponding fields. Based on client configuration, login can require `reCaptcha` restriction. Note that SDK handles validation implementation.

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

userName	The user's user name	string	-	-
password	The user's password	string	-	-
loginType	Accepted login type for authentication Note: When empty, backend checks username first, then email as fallback	string	Login Types	-
encryptedToken	Enables the "Remember Me" functionality. If set to true, the server will include a JWE (JSON Web Encryption) token in the response to allow for persistent, secure sessions	boolean	true / false	false
confirmationCode	Confirmation code received from the backend, sending verification code to the user	string	-	-
gRecaptchaResponse	Google reCAPTCHA response token used for bot protection	string	-	-
birthDate	User's birth date	string	-	-
localIp	User's local ip address	string	-	-
product	Product type for statistical purposes	string	-	-
isBySms	If provided will mark weather the login performed by sms or not, currently SDK sends `true` if user provides it, otherwise SDK sends nothing for this field	boolean	true / false	-
geoComplyToken	The geoComplyToken is an encrypted string generated by the GeoComply	string	-	-
mappingVerificationCode	Contains the user OTP value, received for account linking	string	-	-

This method is usually used with these methods:

registerUser subscribeToUserProfile restoreLogin forgotPassword sendVerificationCodeForLoginBySmsBySms sendWrongLoginAttemptsResetCode

Call example:
JavaScriptReact HookFlutter

login({
  userName: 'user1234',
  password: '12345678!'
})

Response examples:
SuccessError

{
  code: 0,
  hasError: false,
  errorDetails: {
    key: '',
    message: ''
  },
  data: {
    is_client_restricted: false,
    user_id: 394777986,
    auth_token: '246D1AC60948CD73C3D75C77E8278B90',
    qr_code_origin: null,
    authentication_status: 0,
    is_new_client: null,
    deposit_count: 0,
    time_to_wait_in_minutes: null,
    needs_subscriptions_update: false,
    deposit_amount: 0,
    withdrawal_amount: 0,
    jwe_token: 'eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIn0.6UfA_Cfvui4cAnEw6gqod_XS-of554OQGFWbxaT8GmrWVpmbwCY7r7xKL_1WbmT20yuCKABHV9HJv0i8u9uVwCwJzhrXQOiY.9OqL4xgJ8vzYHo3m_xPxOQ.ODDqwVazxPblbdge1LPgtPy14xsdIk_UBEVEJowe6BakKzKYPFRH9AbPJK7kD5-spSOrsNO_yUZhyEKOgYiO2BCN0d7xALDj6uEHTAMvmW7w80e2yqQSaJ6b1GkMXH-0BqWMt75oM7ePofG3HD_FAw.1Czf-b_OOZMs-WXum4RDOlx6PV_szEPKYWncLgJ6_8o'
  }
}

Response parameters:

Name	Description	Type	Values

user_id	The unique internal database identifier for the player	number	-
auth_token	This is the bearer token (JWT or similar)	string	-
authentication_status	Indicates the current security state of the account	number	0 / 4
deposit_count	The total number of deposits made by the user	number	-
qr_code_origin	Likely used for tracking marketing attribution (e.g., if the user registered by scanning a physical QR code) or for generating a specific Two-Factor Authentication (2FA) or payment gateway origin.	string	-
is_new_client	A flag indicating if this is the user's first time logging into the platform.	boolean	true / false
withdrawal_amount	Keeps logged-in user withdraw amount	number	-
jwe_token	Keeps loggedin user token with JWT format	string	-
deposit_amount	Keeps logged-in user deposit amount	number	-
needs_subscriptions_update	After a user’s Self-Exclusion (SE) period ends, all communication subscriptions are explicitly re-confirmed by the user before any communications are resumed When SE is activated, all communication subscriptions are removed After SE expiration, backend provides to the user to update their subscription preferences	string	-
time_to_wait_in_minutes	Holds information when the user self-exclusion time ends	number	-
is_client_restricted	Indicates info when the player's account is restricted, false when it is not. The key is always present in the login response; its value is null when the platform has no information for that player.	boolean	true / false