v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Accounts
Metadata

Gets two step verification system metadata.

The metadata endpoint takes in optional request parameters to output additional context for when the user is unauthenticated but attempting to login with two step verification.

When supplied, all three request parameters must be sent and match up.

get/v1/metadata#twostepverification.roblox.com

Query parameters

userIdinteger

The user ID.

challengeIdstring

The active two step verification challenge ID if there is one.

actionType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

The Roblox.TwoStepVerification.Client.TwoStepVerificationActionType associated with the challenge.

Response

OK

twoStepVerificationEnabledboolean

Whether or not two step verification is globally enabled.

authenticatorQrCodeSizestring

Authenticator QR code image dimensions.

emailCodeLengthinteger

Number of characters in an email-based two step verification code.

authenticatorCodeLengthinteger

Number of characters in an authenticator-based two step verification code.

authenticatorHelpSiteAddressstring

Address of the help site provided to users to help them with authenticator.

isPasswordRequiredForEnablingAuthenticatorboolean

Whether or not a password is required for enabling authenticator.

isPasswordRequiredForEnablingEmailTwoStepVerificationboolean

Whether or not a password is required for enabling email 2sv.

isUsingTwoStepWebviewComponentboolean

Whether or not we're using the new 2sv webview component or the manual pop up

isTwoStepEnabledRequiredForEmailPasswordRequirementboolean

Whether or not a 2sv method has to be enabled to require password when enabling email two step verification.

isTwoStepEnabledRequiredForAuthenticatorPasswordRequirementboolean

Whether or not a 2sv method has to be enabled to require password when enabling authenticator.

isSingleMethodEnforcementEnabledboolean

Whether or not the frontend should enforce single method logic.

isSmsTwoStepVerificationAvailableboolean

Whether or not sms two step verification is available for the user.

isSecurityKeyTwoStepVerificationAvailableboolean

Whether or not security key two step verification is available for the user.

isAuthenticatorWithVerifiedPhoneEnabledboolean

Whether or not someone can enable authenticator with just a verified phone number.

isPasswordRequiredForEnablingSecurityKeyboolean

Whether or not a password is required for enabling Security Key 2SV.

isPasswordRequiredForEnablingSms2SVboolean

Whether or not a password is required for enabling SMS 2SV.

isPasswordRequiredForChangingRecoveryCodesboolean

Whether or not a password is required for making updates to recovery codes.

isPasswordRequiredForDisablingAuthenticatorboolean

Whether or not a password is required for disabling authenticator.

isPasswordRequiredForDisablingEmailTwoStepVerificationboolean

Whether or not a password is required for disabling email 2sv.

isPasswordRequiredForDisablingSms2SVboolean

Whether or not a password is required for disabling SMS 2SV.

isRecoveryCodeGenerationForAuthenticatorSetupEnabledboolean

Whether recovery code generation is attempted upon completion of authenticator setup.

isSecurityKeyOnAllPlatformsEnabledboolean

Whether security keys on all platforms is enabled.

receiveWarningsOnDisableTwoStepboolean

Whether users should receive additional warnings when disabling 2SV.

isAndroidSecurityKeyEnabledboolean

Whether Android security keys is enabled.

isSettingsTabRedesignEnabledboolean

Whether the settings tab redesign is enabled.

twoStepCopyTextEnrollmentStatusinteger

The enum representing which experiment group the user is in.

isEppUIEnabledboolean

Whether the EPP UI is enabled.

isEppRecoveryCodesEnabledboolean

Whether the EPP recovery codes UI is enabled.

maskedUserEmailstring

The masked email for the authenticated user. Typically used in Email 2SV challenges after the challenge has been verified to match the target user.

isUserU13boolean

Whether the user is O13.

isDelayedUiEnabledboolean

Whether the delayed UI is enabled.

is2svRecoveryEnabledboolean

Whether to expose 2SV recovery through the 2SV challenge modal.