post/users/@me/mfa/backup-codes

Get backup codes for multi-factor authentication

Generate and retrieve new backup codes for account recovery. Requires sudo mode verification. Old codes are invalidated.

get_backup_codes_mfa

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "regenerate": {
      "type": "boolean",
      "description": "Whether to regenerate backup codes"
    },
    "password": {
      "$ref": "#/components/schemas/PasswordType"
    },
    "mfa_method": {
      "type": "string",
      "enum": [
        "totp",
        "webauthn"
      ],
      "x-enumNames": [
        "TOTP",
        "WebAuthn"
      ],
      "x-enumDescriptions": [
        "Time-based one-time password authentication via authenticator app",
        "Security key or biometric authentication"
      ],
      "description": "MFA method to use for verification"
    },
    "mfa_code": {
      "type": "string",
      "description": "MFA verification code from an authenticator app"
    },
    "webauthn_response": {
      "type": "object",
      "description": "WebAuthn authentication response"
    },
    "webauthn_challenge": {
      "type": "string",
      "description": "WebAuthn challenge string"
    }
  },
  "required": [
    "regenerate"
  ]
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "backup_codes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "The backup code"
          },
          "consumed": {
            "type": "boolean",
            "description": "Whether the code has been used"
          }
        },
        "required": [
          "code",
          "consumed"
        ]
      },
      "description": "List of backup codes"
    }
  },
  "required": [
    "backup_codes"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}