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

# Begin MFA Setup

> Generate a pending TOTP secret and the otpauth URI for enrolling an authenticator app.

Generates a TOTP secret for the logged-in user and returns the `otpauth://`
URI (render it as a QR code) plus the raw secret (for manual entry). MFA is
**not** enabled until a code from the authenticator is confirmed with
[Verify MFA](/api-reference/auth/mfa-verify). Calling setup again before
verifying replaces the pending secret. Once MFA is enabled, logins require a
second step via [Complete an MFA Login](/api-reference/auth/login-mfa), and it
can be switched off with [Disable MFA](/api-reference/auth/mfa-disable).

Requires a logged-in user session; API-key callers receive `401`.

## Example Request

```bash theme={null}
curl -X POST https://api.recurso.dev/v1/auth/mfa/setup \
  -b cookies.txt
```

## Example Response

```json theme={null}
{
  "secret": "JBSWY3DPEHPK3PXPJBSWY3DPEHPK3PXP",
  "otpauth_url": "otpauth://totp/Recurso:admin@acme.com?algorithm=SHA1&digits=6&issuer=Recurso&period=30&secret=JBSWY3DPEHPK3PXPJBSWY3DPEHPK3PXP"
}
```

## Fields

| Field         | Type   | Description                                                                                                       |
| ------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| `secret`      | string | The base32 TOTP secret, for manual entry into an authenticator app.                                               |
| `otpauth_url` | string | The `otpauth://totp/...` provisioning URI (issuer `Recurso`, account = the user's email). Encode it as a QR code. |

## Errors

| Status | Code             | When                                                                                            | Fix                                                                                            |
| ------ | ---------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| 401    | `unauthorized`   | No live session cookie, or the caller authenticated with an API key rather than a user session. | Sign in via [`/auth/login`](/api-reference/auth/login) and send the `recurso_session` cookie.  |
| 409    | `conflict`       | MFA is already enabled for this user.                                                           | Disable it first with [Disable MFA](/api-reference/auth/mfa-disable) if you need to re-enroll. |
| 500    | `internal_error` | The secret could not be generated or stored.                                                    | Retry; contact support if it persists.                                                         |

Errors use the standard envelope — see [Errors](/api-reference/errors).


## OpenAPI

````yaml POST /v1/auth/mfa/setup
openapi: 3.1.0
info:
  title: Recurso API
  version: 1.0.0
  description: |
    The Recurso billing engine REST API.

    Authenticate by passing your API key as a bearer token:

        Authorization: Bearer <api_key>

    Obtain an API key by registering a tenant via `POST /auth/register`.
    All authenticated endpoints live under the `/v1` prefix. Mutating
    endpoints support idempotency via the `Idempotency-Key` header.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://billing.example.com
    description: >-
      Example deployment — substitute the base URL of your own Recurso
      deployment.
security:
  - bearerAuth: []
tags:
  - name: System
    description: Health, version, and API metadata
  - name: Auth
    description: Tenant registration
  - name: Plans
    description: Product catalog plans
  - name: Customers
    description: Customer management
  - name: Subscriptions
    description: Subscription lifecycle
  - name: Invoices
    description: Invoices, PDFs, and Indian GST e-invoicing
  - name: Coupons
    description: Discounts
  - name: Usage
    description: Metered usage events
  - name: Credit Notes
    description: Customer credits
  - name: Quotes
    description: Quote-to-invoice lifecycle
  - name: Webhooks
    description: Webhook endpoint management and event feed
  - name: Analytics
    description: Revenue analytics
  - name: Checkout
    description: Public hosted checkout for invoices
  - name: Payments
    description: Payment order creation
  - name: Inbound Webhooks
    description: Receivers for payment-gateway callbacks (Razorpay, Stripe)
  - name: Customer Portal
    description: Customer-facing portal — magic-link auth and session-scoped data
  - name: Developer
    description: API key management
  - name: Account
    description: Tenant account settings
  - name: Finance
    description: Ledger accounts, entries, reconciliation, and revenue recognition
  - name: Settings
    description: Tax (GST) and e-invoicing (IRP) configuration
  - name: Consents
    description: Consent records for RBI-compliant recurring billing
  - name: Referrals
    description: Customer referral program
  - name: Gifts
    description: Gift subscriptions
  - name: Mandates
    description: UPI Autopay mandates
  - name: Offline Payments
    description: Virtual accounts and manually recorded payments
  - name: Organizations
    description: Multi-entity organizations grouping several tenants
  - name: Accounting
    description: QuickBooks / Xero accounting integrations
  - name: Churn
    description: Churn risk scoring and alerts
  - name: Cancel Flows
    description: Configurable retention flows shown at cancellation time
  - name: Dunning
    description: Dunning analytics and multi-channel dunning campaigns
paths:
  /v1/auth/mfa/setup:
    post:
      tags:
        - Auth
      summary: Begin TOTP MFA setup
      description: >
        Generates a TOTP secret for the logged-in user and returns the
        otpauth:// URI (for QR display) plus the raw secret (for manual entry).
        MFA is NOT enabled until a code is confirmed via /v1/auth/mfa/verify.
        Requires a logged-in user session (API-key callers are rejected).
      operationId: mfaSetup
      responses:
        '200':
          description: Provisioning data for the authenticator app.
          content:
            application/json:
              schema:
                type: object
                properties:
                  secret:
                    type: string
                  otpauth_url:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/Conflict'
      security:
        - sessionCookie: []
components:
  responses:
    Unauthorized:
      description: Missing or invalid credentials (API key or session cookie).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: >-
        The request conflicts with current state (e.g. duplicate email, last
        owner).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Structured error detail.
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable error code.
              examples:
                - validation_failed
                - unauthorized
                - forbidden
                - not_found
                - conflict
                - rate_limited
                - internal_error
                - invalid_api_key
                - key_mode_mismatch
                - over_refund
                - invoice_not_paid
                - invoice_already_paid
            message:
              type: string
              description: Human-readable explanation.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Tenant API key obtained from `POST /auth/register` or `POST
        /v1/developer/keys`.
    sessionCookie:
      type: apiKey
      in: cookie
      name: recurso_session
      description: >
        Dashboard user session cookie (httpOnly) issued by `POST /auth/register`
        and `POST /auth/login`. v1 endpoints accept EITHER this cookie or the
        tenant API key (`bearerAuth`).

````