> ## Documentation Index
> Fetch the complete documentation index at: https://developers.liara.ir/llms.txt
> Use this file to discover all available pages before exploring further.

# Start two-factor authentication setup

> Generates a new authenticator secret and a QR code for it. Add it to an authenticator app, then confirm with `POST /v1/two-fa`. Codes are 6 digits and change every 30 seconds.



## OpenAPI

````yaml /spec/platform-auth.yaml post /v1/two-fa/config
openapi: 3.0.1
info:
  title: Authentication & Account
  version: 1.0.0
  description: >-
    Log in, issue API tokens, change or reset your password, set up two-factor
    authentication, verify your email address and phone number, and manage your
    account profile and billing contact details.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Login
    description: Exchange your credentials or a one-time code for an API token.
  - name: Registration
    description: Create a new account.
  - name: Password
    description: Change your password while logged in, or reset a forgotten one.
  - name: API Tokens
    description: Issue additional API tokens for your account.
  - name: Account
    description: Read and update your profile and billing contact details.
  - name: Two-Factor Authentication
    description: Set up and manage authenticator-app (TOTP) two-factor authentication.
  - name: Verification
    description: Verify, or change, your account's email address and phone number.
paths:
  /v1/two-fa/config:
    post:
      tags:
        - Two-Factor Authentication
      summary: Start two-factor authentication setup
      description: >-
        Generates a new authenticator secret and a QR code for it. Add it to an
        authenticator app, then confirm with `POST /v1/two-fa`. Codes are 6
        digits and change every 30 seconds.
      operationId: createTwoFAConfig
      responses:
        '200':
          description: A new secret was generated. Nothing is enabled yet.
          content:
            application/json:
              schema:
                type: object
                properties:
                  secretCode:
                    type: string
                    description: Base32 secret to enter in an authenticator app.
                  qrcode:
                    type: string
                    description: The same secret as a QR code, as a PNG `data:` URL.
              example:
                secretCode: <base32-secret>
                qrcode: data:image/png;base64,<image-data>
        '400':
          description: Two-factor authentication is already enabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 400
                error: Bad Request
                message: TwoFA is already enabled.
                data:
                  code: two_fa_already_enabled
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API token as `Authorization: Bearer <api-token>`. Tokens
        expire (30 days by default) and stop working when you change or reset
        your password.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.