post https://{application_vanity_domain}/api/v1/email-verification/verify-email
If the provided emailAuthCode
is valid, the user's email will be marked as verified. Otherwise, if the emailAuthCode
is invalid, a 400 response will be returned containing a Constraint Violations Error like the following:
{
"type": "constraint_violations_error",
"code": "message_body_constraint_violations",
"message": "Field violations were detected in the request body",
"ticket": "jgqgau2nj4eobeaje6m4jhoop8",
"violations": {
"emailAuthCode": [{
"code": "invalid_email_auth_code"
}]
}
}
Required Permissions
Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.
Permission | Boundary | Description |
---|---|---|
email-verification-workflow:execute | Application | The subject can perform this operation on requests associated with the application to which the subject belongs. |