Skip to content

Send verification email

Request

Sends a verification email using the specified method (OTP or magic link) to the specified email address for the selected user.

Required permissions: apps:execute, [appId]:execute, auth:execute.

Security
ClientAccessToken
Path
user_idstringrequired

ID of the user

Bodyapplication/jsonrequired
methodstringrequired

The verification method to use: 'otp' for one-time passcode, 'link' for magic link

Enum:"otp""link"
Example:"otp"
emailstringrequired

Email to send the verification to

Example:"name@example.com"
redirect_uristring

URI where the email link will redirect to. Required when method is 'link'. The verification result will be included as a boolean query parameter called result (for example, https://www.example.com/verify?result=true). This URI must also be configured as an allowed redirect URI in the Admin Portal.

Example:"https://www.example.com/verify"
email_contentobject

Texts, logo and color to render email template with

update_primaryboolean

Allows the request to update the user's current verified primary email. Only applicable when method is 'link'. If the user profile already has a verified primary email, it will override it if true or add it as their secondary email if false

Default:false
curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/email/verification/send' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "method": "otp",
    "email": "name@example.com",
    "redirect_uri": "https://www.example.com/verify",
    "email_content": {
      "subject": "string",
      "primaryColor": "#6981FF",
      "base64logo": "string",
      "headerText": "string",
      "bodyText": "string",
      "linkText": "string",
      "infoText": "string",
      "footerText": "If you didn'\''t request this email, you can safely ignore it.",
      "senderName": "string"
    },
    "update_primary": false
  }'

Responses

Bodyapplication/json
messagestringread-onlyrequired
Example:"Verification email sent"
Response
{
  "message": "Verification email sent"
}