The following documentation is applicable to Free, Developer, and Developer Pro plans. For documentation related to the enterprise plan, please click here.

Multi-Factor Authentication

Refer this document to get API Key and Secret.
Refer this document to get API Key and Secret.

2FA Email Login

Initiates the login process using Email ID on a Two-Factor Authentication (2FA) enabled LoginRadius app.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/login/2FA

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
EmailTemplatenoneEmail template name [Optional]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
LoginUrlnoneUrl where the user is logging from [Optional]
SmsTemplatenoneSMS Template name [Optional]
SmsTemplate2FAnoneSMS Template Name [Optional]
VerificationUrlnoneEmail verification url [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Phone Login

Initiates the login process using Phone ID on a Two-Factor Authentication (2FA) enabled LoginRadius app.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/login/2FA

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
EmailTemplatenoneEmail template name [Optional]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
LoginUrlnoneUrl where the user is logging from [Optional]
SmsTemplatenoneSMS Template name [Optional]
SmsTemplate2FAnoneSMS Template Name [Optional]
VerificationUrlnoneEmail verification url [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Validate Access Token

Validates an access token and starts the Two-Factor Authentication (2FA) process. If 2FA is set to optional and the consumer has no second factor authenticators active, the consumer’s profile information will be returned instead.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/account/2FA

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Enable 2FA Google Authenticator by Access Token

Enables Two-Factor Authentication (2FA) with Google Authenticator for the consumer corresponding to the specified access token.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/account/2FA/Verification/GoogleAuthenticatorCode

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
SmsTemplatenoneSMS Template name [Optional]

Body Attributes

AttributeDescription
GoogleAuthenticatorCodeThe code generated by google authenticator app after scanning QR codeModel Class containing Definition of payload for MultiFactorAuthModel By GoogleAuthenticator Code API [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Validate OTP

Validates the OTP sent to the consumer’s phone number when the Two-Factor Authentication process was started. If successful returns the consumer’s profile data and a LoginRadius access token.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/login/2FA/verification/otp

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
secondfactorauthenticationtokennoneA unique 2FA token generated when the Two-Factor Authentication process was started. [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

Body Attributes

AttributeDescription
otpThe One Time Passcode sent to the consumer. [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Update Phone Number by Token

Updates phone number used for Two-Factor Authentication (2FA) via access token by sending a verification OTP to the specified phone number.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/account/2FA

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Validate Google Auth Code

Logs in via Two-Factor Authentication (2FA) by passing in a Google Authenticator code.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/login/2FA/verification/GoogleAuthenticatorCode

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
SecondFactorAuthenticationTokennoneA Uniquely generated MFA identifier token after successful authentication [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
SmsTemplate2FAnoneSMS Template Name [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Update Phone Number

Updates phone number used for Two-Factor Authentication (2FA) via second factor authentication token by sending a verification OTP to the specified phone number.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/login/2FA

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
SecondFactorAuthenticationTokennoneA Uniquely generated MFA identifier token after successful authentication [Required]
SmsTemplate2FAnoneSMS Template Name [Optional]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Reset Google Authenticator by Token

Resets Google Authenticator configurations for the consumer corresponding to the specified access token.

Endpoint

DELETE https://api.loginradius.com/identity/v2/auth/account/2FA/authenticator

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Reset SMS Authenticator by Token

Resets SMS Authenticator configurations for the consumer corresponding to the specified access token.

Endpoint

DELETE https://api.loginradius.com/identity/v2/auth/account/2FA/authenticator

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Reset SMS Authenticator by UID

Resets SMS Authenticator configurations for the consumer corresponding to the specified UID.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/account/2FA/authenticator

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
UidnoneUID, the unified identifier for each user account [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

2FA Reset Google Authenticator by UID

Resets Google Authenticator configurations for the consumer corresponding to the specified UID.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/account/2FA/authenticator

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
apisecretnoneLoginRadius API Secret [Required]
UidnoneUID, the unified identifier for each user account [Required]

Try Me Out

Click the button below to enter parameters, send a request and see the response.

Go Back to Home Page


Was this article helpful?

Have more questions? Submit a request