Validate email OTP

Request

Validate a one-time passcode (OTP) sent by email. This API is used to verify the email OTP sent to the user. The email will be added to the user profile and marked as verified. The endpoint will not authenticate the user (or create new users), and no tokens are returned.

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

Security

ClientAccessToken

Path

user_idstringrequired

ID of the user

Bodyapplication/jsonrequired

emailstringrequired

Email that the OTP was sent to

passcodestringrequired

Email code to validate

update_primaryboolean

Allows the request to update the user's current verified primary email. 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/verify' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "passcode": "string",
    "update_primary": false
  }'

Responses

Bodyapplication/json

resultbooleanread-onlyrequired

Boolean value indicating if OTP email verification succeeded

Response

{
  "result": true
}