Users

Verify a TOTP or backup code for a user

Verify that the provided TOTP or backup code is valid for the user. Verifying a backup code will result it in being consumed (i.e. it will become invalid). Useful for custom auth flows and re-verification.

post/users/{user_id}/verify_totp

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/users/{user_id}/verify_totp
  • Auth: HTTP bearer

Path parameters

user_idstring required

The ID of the user for whom to verify the TOTP

Request body

codestring required

The TOTP or backup code to verify

Response

The provided TOTP or backup code was correct.

verifiedboolean
code_type'totp' | 'backup_code'

Changes

No recorded changes to this operation across all 49 revisions of this API.