POST /users/verification-email – Sends a verification email to a user.

  • Verification emails:
    • Have a limited validity period
    • Can be rate-limited per user
    • May be customized based on client_id
    • Support multiple languages based on user preferences
    • Include a secure verification link
    • Are sent from a verified sender address
  • Previous verification links are invalidated when new ones are sent.

Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

Path Parameters:

  • None

Query Parameters:

  • None

  • 201 Created – Verification email successfully sent.

Status Code Meaning When it Happens
400 Bad Request Missing or invalid parameters
401 Unauthorized Missing or invalid authentication token
404 Not Found User not found
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Unexpected error
{
"error": "Detailed error message here"
}

POST /users/verification-email
{
"provider": "auth0-user",
"userId": "exampleUserId",
"clientId": "client_xyz"
}
POST /users/verification-email
{
"provider": "cognito-user",
"userId": "cognitoUser@email.com",
"clientId": "client_xyz"
}
{}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.