Verify 2FA code

POST

/api/v1/auth/2fa/verify

curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/auth/2fa/verify \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "code": "example", "two_factor_token": "example" }'

• Production
• Local development

Complete login by verifying TOTP or recovery code.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

TwoFactorVerifyRequest

Request to verify 2FA during login.

object

code

required

Code

TOTP code or recovery code

string

two_factor_token

required

Two Factor Token

2FA token from login response

string

Example^generated

{
  "code": "example",
  "two_factor_token": "example"
}

Responses

200

Successful Response

Media typeapplication/json

LoginResponse

Response body for the login endpoint.

Attributes: access_token: A short-lived JWT access token. refresh_token: A long-lived JWT refresh token. token_type: Always ‘bearer’. two_fa_required: Whether a second factor is needed. two_fa_token: Short-lived token for 2FA verification.

object

2fa_methods

2Fa Methods

Array<string>

Allowed values: totp recovery webauthn

2fa_required

2Fa Required

Whether 2FA verification is required

boolean

2fa_token

Any of:

string

string

null

null

access_token

Access Token

Short-lived JWT access token

string

""

refresh_token

Refresh Token

Long-lived JWT refresh token

string

""

token_type

Token Type

Token scheme, always ‘bearer’

string

default: bearer

Example

{
  "2fa_methods": [
    "totp"
  ],
  "2fa_required": false,
  "access_token": "",
  "refresh_token": "",
  "token_type": "bearer"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}