Retrieve Email Verification Token

Retrieves an Email Verification Token for a specified Email.

GET
/identity/v2/manage/account/vtoken

Retrieves an Email Verification Token for a specified Email.

Authorization

apikey<token>

Tenant API Key for authentication

In: query

apisecret<token>

Tenant API Secret for authentication

In: query

Query Parameters

email?string

Email address of the associated Account.

Formatemail
vtype*string

The type of verification. Currently, only "Email" is supported.

Value in"email"
expires_in?string

The expiration time for the token in seconds.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.loginradius.com/identity/v2/manage/account/vtoken?email=test%40gmail.com&vtype=email&expires_in=3600"
{
  "VerificationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": "2024-03-20T15:30:00Z"
}

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

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

{
  "ErrorCode": 1034,
  "Message": "Verification emails cannot be sent, as the email verification option is disabled for your site",
  "Description": "The email address verification option is disabled for your site, please enable it before sending any verification emails."
}