Skip to content

Send an email verification code​

POST
/cognito/email-code/send

Sends the signed-in account's own sign-in address a new verification email with a code to type in and the link. Nothing in the request names an address. A new code replaces the last one. The first code is sent by POST /cognito/signup with verifyWith: code; this is "Resend code".

One code a minute and five an hour per account (429 VERIFICATION_CODE_RATE_LIMITED with retryAfterSeconds and a Retry-After header). After too many wrong codes in total the code path is closed for that address (429 VERIFICATION_CODE_LOCKED) and only the link verifies it.

Needs a real sign-in session. Rate limited at 30 requests/minute per account and 60 per IP.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Responses​

Sent, or nothing to verify

application/json
JSON
{
"sent": true,
"alreadyVerified": true,
"length": 6,
"expiresInSeconds": 600,
"maxAttempts": 5,
"resendAfterSeconds": 60
}

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI

Built with VitePress