Skip to content

Confirm the email with a typed code​

POST
/cognito/email-code/confirm

Verifies the signed-in account's sign-in address with the code from the verification email. A right code does exactly what following the link does. A code works once, for ten minutes, for the account it was sent to, and allows five tries.

A wrong or expired code answers 400 INVALID_VERIFICATION_CODE, with attemptsLeft when the try was counted. After too many wrong codes in total: 429 VERIFICATION_CODE_LOCKED; the link in the email still works. An address that is already verified answers 200 with alreadyVerified: true.

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)

Request Body​

application/json
JSON
{
"code": "string"
}

Responses​

Verified

application/json
JSON
{
"verified": true,
"alreadyVerified": true
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress