POST/mfa/verify

Verify an MFA code during login

Verifies an MFA code during login. Provide a six-digit authenticator-app code or a one-time backup code to complete verification.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

MFA verification details; code is required.

codestringrequired
6-digit TOTP code from the authenticator app, or a one-time backup code.

3 status codes
200Returns confirmation of MFA verification in the successful response envelope, including the payload in `data` and the `status` and `success` fields.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when the MFA code is invalid.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
401Returned when the MFA token is invalid.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when the supplied code is invalid. A 401 is returned when the MFA token is invalid; provide a valid token and the associated MFA code.