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

Phone Authentication

Refer this document to get API Key and Secret.

Phone Login

Exchanges consumer login details for a copy of their user data and a LoginRadius access token.

Endpoint

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

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
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]

Body Attributes

AttributeDescription
passwordPassword for the email
phoneNew Phone NumberModel Class containing Definition of payload for PhoneAuthenticationModel API [Required]

Try Me Out

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

Phone Forgot Password by OTP

Sends a verification OTP SMS to reset the consumer’s password.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/password/otp

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
SmsTemplatenoneSMS Template name [Optional]

Try Me Out

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

Phone Resend Verification OTP

Resends a verification OTP SMS to verify the consumer’s Phone ID.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/phone/otp

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
SmsTemplatenoneSMS Template name [Optional]

Try Me Out

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

Phone Resend Verification OTP by Token

Resends a verification OTP SMS to verify the consumer’s Phone ID in cases where the consumer is already logged in.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/phone/otp

Query Parameters

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

Try Me Out

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

Phone User Registration by SMS

Registers a new consumer on your app and triggers the Phone ID verification process.

Endpoint

POST https://api.loginradius.com/identity/v2/auth/register

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
sottnoneLoginRadius Secured One Time Token [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
OptionsnonePreventVerificationEmail (Specifying this value prevents the verification email from being sent. Only applicable if you have the optional email verification flow) [Optional]
SmsTemplatenoneSMS Template name [Optional]
VerificationUrlnoneEmail verification url [Optional]
WelcomeEmailTemplatenoneName of the welcome email template [Optional]

Body Attributes

AttributeDescription
FirstNameuser’s first name
LastNameuser’s last name
PasswordPassword for the email
PhoneIdPhone ID (Unique Phone Number Identifier of the user)Model Class containing Definition of payload for Auth User Registration API [Required]

Try Me Out

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

Phone Number Availability

Checks if the specified Phone ID already exists on your app.

Endpoint

GET https://api.loginradius.com/identity/v2/auth/phone

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
PhonenoneThe Registered Phone Number [Required]

Try Me Out

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

Phone Reset Password by OTP

Resets the consumer’s password by consuming their verification OTP.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/password/otp

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]

Body Attributes

AttributeDescription
otpThe Verification Code
passwordPassword for the email
PhoneNew Phone NumberModel Class containing Definition of payload for ResetPasswordByOTP API [Required]

Try Me Out

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

Phone Verification OTP

Validates the verification OTP sent to verify the consumer’s Phone ID.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/phone/otp

Query Parameters

ParameterDefaultDescription
apikeynoneLoginRadius API Key [Required]
OtpnoneThe Verification Code [Required]
FieldsnoneThe fields parameter filters the API response so that the response only includes a specific set of fields [Optional]
SmsTemplatenoneSMS Template name [Optional]

Try Me Out

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

Phone Verification OTP by Token

Consumes the verification OTP sent to verify the consumer’s Phone ID when the consumer is already logged in.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/phone/otp

Query Parameters

ParameterDefaultDescription
access_tokennoneUniquely generated identifier key by LoginRadius that is activated after successful authentication. [Required]
apikeynoneLoginRadius API Key [Required]
OtpnoneThe Verification Code [Required]
SmsTemplatenoneSMS Template name [Optional]

Try Me Out

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

Phone Number Update

Updates the Phone ID of the consumer corresponding to the specified access token.

Endpoint

PUT https://api.loginradius.com/identity/v2/auth/phone

Query Parameters

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

Try Me Out

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

Remove Phone ID by Access Token

Deletes the Phone ID from the consumer corresponding to the specified access token.

Endpoint

DELETE https://api.loginradius.com/identity/v2/auth/phone

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.

Go Back to Home Page


Was this article helpful?

Have more questions? Submit a request