How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FusionAuth Two Factor API

The Two Factor API from FusionAuth — 7 operation(s) for two factor.

FusionAuth Two Factor API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Two Factor. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

7 operations 7 paths 35 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth Two Factor API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Two Factor 7
POST
/api/two-factor/login
Complete login using a 2FA challenge
twoFactorLoginWithId body → 200default
GET
/api/two-factor/secret
Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain both the secret and a Base32 encoded form of the secret which can be shown to a…
generateTwoFactorSecretUsingJWTWithId → 200default
POST
/api/two-factor/send
Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
sendTwoFactorCodeForEnableDisableWithId body → 200default
POST
/api/two-factor/send/{twoFactorId}
Send a Two Factor authentication code to allow the completion of Two Factor authentication.
sendTwoFactorCodeForLoginUsingMethodWithId 1 param body → 200default
POST
/api/two-factor/start
Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send API (/api/two-factor/send)in order to send a one-time use code to a user. You…
startTwoFactorLoginWithId body → 200default
POST
/api/two-factor/status
Retrieve a user's two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust acro…
retrieveTwoFactorStatusWithRequestWithId body → 200default
GET
/api/two-factor/status/{twoFactorTrustId}
Retrieve a user's two-factor status. This can be used to see if a user will need to complete a two-factor challenge to complete a login, and optionally identify the state of the two-factor trust acro…
retrieveTwoFactorStatusWithId 3 params → 200default

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are User (40 properties), LoginResponse (19 properties), UserRegistration (16 properties), UserIdentity (11 properties). Each schema is shown below with its type and property counts.

TwoFactorLoginRequest
object
9 properties
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
User
object
The public, global view of a User. This object contains all global information about the user including birthdate, registration information preferred languages…
40 properties
ContentStatus
string
Status for content like usernames, profile attributes, etc.
UserRegistration
object
User registration information for a single application.
16 properties
GroupMember
object
A User's membership into a Group
5 properties
MetaData
object
3 properties
MessageType
string
Location
object
Location information. Useful for IP addresses and other displayable data objects.
7 properties
TwoFactorStartResponse
object
3 properties
TwoFactorTrust
object
3 properties
BreachedPasswordStatus
string
LoginResponse
object
19 properties
Locale
string
A Locale object represents a specific geographical, political, or cultural region.
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
DeviceInfo
object
5 properties
TwoFactorStartRequest
object
7 properties
UserIdentity
object
11 properties
SecretResponse
object
2 properties
Error
object
Defines an error.
3 properties
ZoneId
string
Timezone Identifier
EventInfo
object
Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
8 properties
LocalDate
string
A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.
TwoFactorStatusRequest
object
Check the status of two-factor authentication for a user, with more options than on a GET request.
6 properties
MultiFactorAction
string
Communicate various actionscontexts in which multi-factor authentication can be used.
TOTPAlgorithm
string
LoginPreventedResponse
object
The summary of the action that is preventing login to be returned on the login response.
10 properties
TwoFactorStatusResponse
object
2 properties
IdentityType
object
Model identity types provided by FusionAuth.
1 property
AuthenticatorConfiguration
object
3 properties
ChangePasswordReason
string
TwoFactorSendRequest
object
7 properties
UserTwoFactorConfiguration
object
2 properties
TwoFactorMethod
object
7 properties
IdentityVerifiedReason
string
Models the reason that {@link UserIdentityverified} was set to true or false.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-two-factor-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
FusionAuth Application API
FusionAuth Connector API
FusionAuth Consent API
FusionAuth Email API
FusionAuth Entity API
FusionAuth Form API
FusionAuth Group API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
Where this information came from

This is an independent, third-party profile of FusionAuth Two Factor API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.