Verify an invited user's email address
POST
/v1/auth/verify-email
const url = 'https://example.com/v1/auth/verify-email';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"token":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/auth/verify-email \ --header 'Content-Type: application/json' \ --data '{ "token": "example" }'Request Body required
Section titled “Request Body required ” Media type application/json
object
token
required
string
Example generated
{ "token": "example"}Responses
Section titled “ Responses ”Email verified successfully.
Media type application/json
object
message
required
string
email
required
string
Example generated
{ "message": "example", "email": "example"}Invalid or expired token.
Media type application/json
object
code
required
Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).
string
message
required
Human-readable description of the error.
string
details
Optional additional context about the error.
object
key
additional properties
any
notices
Policy notices from determining Cedar rules, if applicable.
Array<string>
Example generated
{ "code": "example", "message": "example", "details": {}, "notices": [ "example" ]}