LoginRadius DocsDocs
DocumentationAPI ReferencesSDKsChangelogs

Send OTP for PIN Reset

Sends a One-Time Password (OTP) to the User's registered Phone number, enabling them to reset their PIN if forgotten.

POST
/identity/v2/auth/pin/forgot/otp

Sends a One-Time Password (OTP) to the User's registered Phone number, enabling them to reset their PIN if forgotten.

Authorization

apikey<token>

Tenant API Key for authentication

In: query

Query Parameters

smstemplate?string

SMS Template

isvoiceotp?boolean

Boolean flag to enforce sending SMS content via Voice.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

phone*string

The Phone number of the User.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.loginradius.com/identity/v2/auth/pin/forgot/otp?smstemplate=SMS-Template&isvoiceotp=true" \  -H "Content-Type: application/json" \  -d '{    "phone": "+1234567890"  }'
{
  "IsPosted": true,
  "Data": {
    "AccountSid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "Sid": "SMXXXXXXXXXXXXXXXX"
  }
}

{
  "ErrorCode": 908,
  "Message": "A parameter is not formatted correctly",
  "Description": "The apikey is a required parameter."
}

{
  "errorCode": 1409,
  "message": "Authentication failed",
  "description": "The credentials provided could not be authenticated."
}

{
  "ErrorCode": 901,
  "Message": "The API key is unauthorized",
  "Description": "The provided LoginRadius API key is invalid or is not authorized, please use a valid or authorized LoginRadius API key or check the API key for your LoginRadius account."
}

Send PIN Reset Email by Username POST

Sends a PIN reset Email to the User IDentified by their Username, enabling them to reset their PIN if forgotten.

Reset PIN with OTP PUT

Allows a User to reset their PIN by verifying a One-Time Password (OTP). The User must provide the OTP, a new PIN, and one identifier (Phone, Email, or Username), enabling secure PIN recovery when the User forgets their PIN.