LI PASS Web Configurations

Initialization parameter	Type	Description	Remarks
env	string	SDK environment, test is used for the test environment For more information, see Retrieve cluster information	Required
gameID	number	Game ID	Required
appID	string	App ID, ACCOUNT_APP_ID assigned by Player Network Console	Required
WebID	string	Web ID, Get from Player Network Console	Optional
config	object	Advanced configurations	Optional

config

note

If configurations for LI PASS web have been created in Player Network Console, most parameters in config can be selected in Player Network Console and does not need to be configured manually. Configurations in Player Network Console takes precedence over config.

Parameter	Type	Description	Remarks
isMobile	boolean	Whether to display the mobile interface	Optional Default: false (display PC interface) If Layout type is set to Custom configuration in Player Network Console, the value of isMobile should be set dynamically by determining the device environment.
socialList	string[]	List of supported third-party login channels such as facebook, twitter, google, apple, line, steam, epic, ps5, discord, vk, twitch, qq, wechat	Optional Default: []
socialParams	object	Additional configurations for third-party login	Required for Apple, Kakao v3 Default: {}
renderMode	string	Display mode inline: Normal mode modal: Modal mode	Optional Default: inline
loginWithCode	object	Configurations for verification code login	Optional Default: { enable: true, registerType: 'manual'}
loginWithPwd	object	Configurations for password login	Optional Default: { enable: true, registerType: 'manual'}
procedureSwitch	object	Procedure switches	Optional Default: { region: false, adultStatus: false, agreement: false, registerPassword: 'onDemand'}
crossGameLink	boolean	Whether to enable account linking across multiple games	Optional Default: false Currently not available in Player Network Console
serviceIntro	boolean	Whether to include a link to the LI PASS service introduction	Optional Default: false Currently not available in Player Network Console
langType	string	Default language, see Language list for more details	Optional Default: en Not supported in Player Network Console

socialParams

Parameter	Type	Description	Remarks
appleAppId	string	Web app ID for Apple	Required for Apple
platform	number	Specifies the login method for Garena 1: Garena 3: Facebook 8: Google 10: Apple 11: Twitter	Optional for Garena
kakaov3AppId	string	Kakao app ID	Required for Kakao v3
kakaov3JsKey	string	Kakao Javascript key	Required for Kakao v3

loginWithCode

Parameter	Type	Description	Remarks	Default
enable	boolean	Whether to enable verification code login	Optional	true
registerType	string	Registration type manual: Only manual registration is allowed auto: Unregistered users will be automatically registered disabled: Disable registration	Optional	manual

loginWithPwd

Parameter	Type	Description	Remarks	Default
enable	boolean	Whether to enable password code login	Optional	true
registerType	string	Registration type manual: Only manual registration is allowed disabled: Disable registration	Optional	manual

procedureSwitch

Parameter	Type	Description	Remarks
region	boolean	Region switch, affects the display of adultStatus and agreement false: Region information is not required during registration, and is not verified during login true: Region information is required during registration, is verified during login, and additional input will be required if information is incomplete	Optional
adultStatus	boolean	Adult status switch, dependent on the state of the region switch and has no effect when enabled by itself false: Birth date or age verification is not required during registration, and is not verified during login. true: Depending on the selected region, birth date or adult declaration is required during registration, is verified during login, and additional input will be required if information is incomplete. Not displayed if the selected region is outside of compliance requirements.	Optional Default: false
agreement	boolean	Agreement switch, dependent on the state of the region switch Basic agreements: Terms of Service [Required], Privacy Policy [Required], subscription to marketing emails [Optional] Region-specific agreements: Data Transfer Notice [Required] (EEA/Switzerland, except the United Kingdom), subscription to nighttime marketing email [Optional] (South Korea only) false: Agreements are not displayed during registration, and user consent to the agreements is not verified during login. true, region=true: Depending on the selected region, all relevant agreements are displayed during registration, and user consent to the agreements is verified during login. If the user has not consented to the required agreements, additional consent will be required. Optional agreements are shown to users only once per website. true, region=false: Only basic agreements are displayed during registration, and user consent to only the basic agreements is verified during login. If the user has not consented to the required agreements, additional consent will be required.	Optional Default: false
unrestrictedRegion	string[]	Remove restrictions for regions that are restricted by default An array consisting of the three-digit region code, for example: ['356']	Optional Default: [] Currently not available in Player Network Console
registerPassword	string	Password setup mode, affects loginWithPwd When the user attempts to log in with a password, if password has not been set before, a popup will be shown to prompt the user to set a password or to log in with a verification code. disabled: Password setup is not required during registration, the interface to set up password will not be displayed. required: Password setup is required during registration, the step cannot be skipped. onDemand: Password setup is optional, the user can decide whether to set up password during registration.	Optional Default: onDemand