Get my two-factor status
GET /account/security/2fa
Shows where your two-factor authentication stands: whether you’ve started setting it up, whether it’s confirmed, and how many recovery codes you have left.
enrolled turns true as soon as you start setup with POST /account/security/2fa, but signing in only asks for a second factor
once confirmed is true too. If you haven’t started, you get
false, false and 0, and the timestamps are left out.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”Your two-factor status.
Where your two-factor setup stands.
object
true once you’ve started setup, whether or not you’ve confirmed it.
true once you’ve confirmed setup with a code. Only then does
signing in ask for a second factor.
When the current setup was started. Starting setup again resets it.
When the server last recorded accepting a code from your authenticator app during sign-in. A later sign-in step can still fail. Signing in with a recovery code doesn’t update it, and starting setup again clears it.
How many unused recovery codes your account has. It’s 0 whenever setup hasn’t been started. While a new setup waits to be confirmed, it can still count codes from an earlier one; confirming replaces them.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}