Experience

Verify TOTP verification

Verifies the provided TOTP code against the new created TOTP secret or the existing TOTP secret. If a verificationId is provided, this API will verify the code against the TOTP secret that is associated with the verification record. Otherwise, a new TOTP verification record will be created and verified against the user's existing TOTP secret.

post/api/experience/verification/totp/verify

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/experience/verification/totp/verify
  • Auth: none required

Request body

codestring required

The TOTP code to be verified.

verificationIdstring

The verification ID of the newly created TOTP secret. This ID is required to verify a newly created TOTP secret that needs to be bound to the user account. If not provided, the API will create a new TOTP verification record and verify the code against the user's existing TOTP secret.

Response

The TOTP code has been successfully verified.

verificationIdstring required

The unique verification ID of the TOTP verification record. For newly created TOTP secret verification record, this ID is required to bind the TOTP secret to the user account through Profile API.

Changes

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