Skip to content
em sa em sa

Request Email Confirmation

POST
/api/auth/request-email-confirmation
 
curl --request POST \
  --url https://example.com/api/auth/request-email-confirmation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example" }'

Request a confirmation email for linking an email identity.

Authenticated endpoint — requires a valid access token. Rate-limited to 3 requests per email per 15-minute window. Returns 202 on success, 503 if email transport is down. Response does not reveal whether the email is already registered.

Body: email: Email address to confirm and link

Returns: {“message”: “If that email can be linked, a confirmation email has been sent.”}

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
EmailConfirmationRequestBody
object
email
required
Email
string
Example generated
{
  "email": "example"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Successful Response

Media type application/json
MessageResponse

Generic {"message": str} response — used by magic-link request, email confirmation request, and other intentionally-vague endpoints that want to avoid leaking whether an email is registered.

object
message
required
Message
string
Example generated
{
  "message": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}