Send an email magic link to the given email address. This requires a logged-in user so it must be authorized using a valid user access token returned upon successful authentication
| email required | string Email to send the magic link to |
| redirect_uri required | string URI where the email link will redirect to. 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. |
object Texts, logo and color to render email template with | |
| update_primary | boolean Default: false 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 |
{- "email": "name@example.com",
- "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."
}, - "update_primary": false
}{- "message": "Verification email sent"
}Send a one-time passcode (OTP) by email to the given email address. This requires a logged-in user so it must be authorized using a valid user access token returned upon successful authentication.
{- "email": "name@example.com",
- "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."
}
}{- "message": "Email sent successfully"
}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.
{- "email": "string",
- "passcode": "string",
- "update_primary": false
}{- "result": true
}Send a one-time passcode (OTP) by SMS to the given phone number. This requires a logged-in user so it must be authorized using a valid user access token returned upon successful authentication
| custom_message | string Message to send, must contain {otp} and {app} placeholders to be replaced with one time password and application name. Limited to 140 characters |
| sender_id | string The sender name that appears as the message sender on recipients devices. Limited to 11 characters. Limited support see https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html |
| phone_number required | string Phone number to send the OTP to |
{- "custom_message": "string",
- "sender_id": "string",
- "phone_number": "string"
}{- "message": "SMS sent"
}Validate a one-time passcode (OTP) sent by SMS. This API is used to verify the SMS OTP sent to the user. The phone number 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.
{- "phone_number": "string",
- "passcode": "string",
- "update_primary": false
}{- "result": true
}