Skip to content

Confirm the texted code​

POST
/users/me/phone-verification/confirm

Cognito checks the code (VerifyUserAttribute on phone_number). Once Cognito reports the number verified, the profile records the number Cognito verified and phone_verified = true, and the change is audited (user.phone_verified). 10 tries an hour per person (429 too_many_tries). Same 401, 403 and 503 answers as send.

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": "123456"
}

Responses​

Verified.

application/json
JSON
{
"phoneVerified": true,
"phone": "string"
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress