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

# Create signup

> First time using Finta: call this endpoint with their email and `app` if known.
Before signup, use what you can already reach (chat, local files, `git config user.email`,
connected tools) to gather context, within the permissions they've given you; propose the
email with its source; ask only if none is found. Gather incorporation year,
entity type, state, what they sell, foreign subsidiaries (now or soon), banks, credit cards.
Send one message with the email and prefilled answers, their sources, conflicts and missing
questions (start with year/entity/state if nothing is known). Confirm together; ask if first
time only if not already known. Already uses Finta: skip signup and sign in.
No API key, company or OAuth grant is needed. Existing accounts get the same 202 and no email.
New accounts receive a verification link; pending accounts receive a replacement link
that invalidates the previous one. Links expire after one hour. Active, inactive and deleted
accounts receive no email. Every account state returns the identical 202 response and
consumes the same email allowance, so neither responses nor 429s reveal account existence.
If no account exists and the email has a pending team invitation, resend that invitation
instead of creating an owner account. This uses the same signup allowance and 202 response.
`verification_sent` is an instruction, not confirmation that an email was delivered.
Every admitted request queues the same background job. After an allowance is consumed,
account creation, resend and mailer failures are reported internally and still
return the same 202 response for every account state; the allowance is not refunded.
Success confirms neither account creation nor email delivery. The kill switch, email
validation and rate-limit checks retain their documented error responses.

Follow `next_step.message`: the user clicks Activate in Finta's email in their own
browser; never fetch the link. Then connect Finta's MCP (`mcp_url`) the way your app
supports; they sign in with one Allow. If your app must restart to load it, tell them
exactly how to restart and come back to this chat, and call no Finta tool until then.
E.g. Codex CLI: they quit (Ctrl+C twice) and run
`codex mcp add finta --url <mcp_url> && codex resume --last` (don't run it yourself);
Claude Code: run `claude mcp add --transport http finta <mcp_url>` if you haven't,
then they run /mcp and pick finta. Once connected, call `get_onboarding` and follow `next_step.message`.
No email? Existing accounts get none; just connect and sign in.
Activating an agent-issued link replaces any pending-account password with a new random one, including a password chosen
during a prior web signup. Requesting or opening the link does not change that password.
There is no status or verify endpoint.

This endpoint bypasses company permissions, onboarding, monthly limits and request logging.
It always uses the unauthenticated 120 requests/minute per-IP limit, even with a credential.
Signup verification also allows 3 attempts per recipient per 30 minutes and 5 per 24 hours,
and 10 auth emails per IP per 10 minutes and 100 per 24 hours (IP limits shared across auth
email purposes). MCP signup enforces these same recipient and caller-IP email limits,
including provider egress IPs; User-Agent branding does not grant an exemption.
A 429 includes Retry-After in seconds; wait that long before retrying.
Repeating a request renews a pending link and consumes an attempt. Rollout is off by default;
while paused, use the web signup URL in the 503 message.




## OpenAPI

````yaml /openapi.yaml post /signups
openapi: 3.0.3
info:
  title: Finta API
  version: '1.0'
  description: >
    The Finta API provides programmatic access to your company's financial data,

    including transactions, journal entries, categories, financial reports,
    sheets, and the team directory.


    ## Authentication


    Each API key is scoped to a single company. There is no company ID
    parameter.

    The key already knows which company it belongs to. If you have access to
    multiple

    companies, create a separate key for each.


    A key acts as its owner; it does not have a separate permission snapshot.
    The owner

    must currently have **API access: Manage**, plus the permission required by
    the endpoint:


    | Endpoint | Required permission |

    |----------|---------------------|

    | `GET /sheets`, `GET /sheets/{id}`, `GET /sheets/{id}/cells` | Forecast:
    View |

    | `POST /sheets`, `PATCH /sheets/{id}`, `DELETE /sheets/{id}` | Forecast:
    Manage; existing sheet entitlements apply |

    | `GET /company` | Company: View |

    | `GET /onboarding`, `PATCH /onboarding` | Company: Manage and Integrations:
    Manage, as onboarding needs in the web app |

    | `GET /taxes`, `GET /taxes/{id}` | Taxes: View |

    | `POST /files`, `POST /file_uploads`, `POST /taxes/income_uploads`, `POST
    /taxes/franchise_uploads` | Taxes: Manage |

    | `GET /team` | Team & access: View |

    | `DELETE /team/invitations/{id}` | Team & access: Manage; target-management
    limits apply. No additional Growth/RBAC gate. |

    | `POST /team/invitations/{id}/resend` | Admin role required. No additional
    Growth/RBAC gate. |

    | `PATCH /team/invitations/{id}` | Team & access: Manage; RBAC and
    active/trialing Growth required, with grant and target limits. |

    | `POST /team/invitations` | Admin role required; requested access must also
    be allowed by the plan. |

    | `GET /categories`, `GET /departments`, `GET /rules`, `GET /rules/{id}` |
    Accounting setup: View |

    | `GET /tags` | Accounting setup: View; early access |

    | `POST /tags`, `PATCH /tags/{id}`, `DELETE /tags/{id}` | Accounting setup:
    Manage; early access |

    | `POST /categories` | Accounting setup: Manage; some templates also need
    the Startup plan, and some only Finta adds |

    | `POST /rules` | Accounting setup: Manage; applying to existing
    transactions (`apply_to_existing_transactions`, default true) also requires
    Transactions: Manage |

    | `PATCH /rules/{id}` | Accounting setup: Manage; Transactions: Manage is
    not required |

    | `DELETE /rules/{id}` | Accounting setup: Manage and Transactions: Manage,
    including absent retries |

    | `GET /integrations` | Integrations: View |

    | `GET /tax_credits`, `GET /tax_credits/{id}` | Taxes: View |

    | `GET /reports/*`, `POST /reports/exports` | Reports: View |

    | `GET /accounts`, `GET /cards`, `GET /transactions`, `GET
    /transactions/{id}`, `GET /transactions/splits`, `GET /spreads` |
    Transactions: View |

    | `GET /forms/1099`, `GET /forms/1099/{id}` | Taxes: View |

    | `POST /transactions/bulk/update`, `GET /jobs/{id}` | Transactions: Manage
    |

    | `PATCH /transactions/{id}`, `POST /transactions/{id}/split`, `PATCH
    /transactions/{id}/split`, `DELETE /transactions/{id}/split`, `POST
    /accounts`, `POST /transaction_uploads`, `POST /transfers`, `DELETE
    /transfers/{id}` | Transactions: Manage |

    | `GET /journal_entries`, `GET /journal_entries/{id}`, `GET
    /aggregations/total`, `GET /aggregations/totals`, `GET /parties/merchants` |
    Reports: View |

    | `GET /invoices`, `GET /invoices/{id}` | Invoices: View |

    | `POST /invoices`, `POST /invoices/{id}/void` | Invoices: Manage |

    | `POST /invoices/{id}/match`, `POST /invoices/{id}/unmatch`, `POST
    /transactions/{id}/match_invoices` | Invoices: Manage and Transactions:
    Manage |


    Permission changes apply to the next request. Removing API access
    permanently revokes

    the owner's active keys for that company; restoring access requires creating
    a new key.


    Authenticate by including your API key in the `Authorization` header:


    ```

    Authorization: Bearer finta_...

    ```


    ### Key prefix convention


    Every Finta credential is prefixed so it can be recognized at a glance in
    logs, error messages, and secret scanners. Today there is one credential
    type and its prefix is `finta_`. As additional credential or token types are
    introduced (for example restricted keys or webhook signing secrets), each
    will have its own distinct prefix that stacks on the brand prefix (e.g.
    `finta_<type>_...`). Treat the prefix as load-bearing: do not strip it
    before sending, and do not assume a missing or unknown prefix is still a
    Finta credential.


    ## Onboarding


    A company starts using Finta by onboarding: it answers a short
    questionnaire, Finta decides

    whether it can take the company on, the company connects the banks and cards
    it selected, and

    Finta syncs them for the first time. Until the company is onboarded, every
    endpoint returns

    `403 Forbidden` with `type: permission_error` and `code:
    onboarding_incomplete`, except these:


    | Endpoint | Why |

    |----------|-----|

    | `GET /onboarding`, `PATCH /onboarding` | Onboarding itself |

    | `GET /integrations` | To see the banks and cards to connect |

    | `POST /integrations/{key}/connect`, `GET /integrations/{key}/connect` | To
    connect them, only once Finta has approved the company (`onboarding_status`
    `connect_banks` or `syncing`) |

    | `POST /team/invitations` | To invite the teammate who can approve a
    connection, such as a Brex account admin |

    | `POST /feedback` | To write to Finta support |


    The error's `onboarding_status` says where the company is (the `status` of
    `GET /onboarding`):


    ```json

    {
      "error": {
        "type": "permission_error",
        "code": "onboarding_incomplete",
        "message": "This company hasn’t finished onboarding with Finta, so this endpoint isn’t available yet. Call GET /api/v1/onboarding and follow its next_step.",
        "doc_url": "https://www.finta.com/docs/api-reference/errors#onboarding_incomplete",
        "onboarding_status": "connect_banks"
      }
    }

    ```


    Call `GET /onboarding` and follow its `next_step` until its `status` is
    `complete`. A company

    Finta needs a call with (`call_required`) or can't onboard (`not_eligible`)
    stays here, as it

    does in the web app. Nothing counts toward the monthly limit until the
    company is onboarded.


    Connecting banks is part of onboarding, but only after Finta approves the
    company, as in the

    web app: a bank connected earlier would sync outside onboarding, and
    onboarding's first sync

    would never start. Before approval, both connect endpoints return
    `onboarding_incomplete`

    with a message to finish the questionnaire first. `GET /integrations`
    answers throughout.


    ## Rate Limits


    The API enforces two independent limits. Both surface as `429 Too Many
    Requests`, but they are distinct error codes with different retry guidance.


    ### Per-minute burst limit


    Authenticated requests are limited to **6,000 requests per 60 seconds** (100
    per second) per API key. Unauthenticated requests (missing or invalid key)
    are limited to **120 requests per 60 seconds** per IP address.


    The window is **fixed**, not rolling. Each 60-second wall-clock interval is
    its own counter; all requests within that interval share it, and the counter
    resets to 0 in a single step at the next boundary. Available budget jumps
    from `0` back to the full bucket size (`6000` for authenticated API keys,
    `120` for unauthenticated IP buckets) instantaneously at the boundary,
    rather than aging out one slot at a time. Trust `X-RateLimit-Reset` for the
    exact reset timestamp.


    Successful responses and burst-limit rejections include the following
    headers.

    Do not assume they are present on other errors: early authentication,
    authorization,

    and monthly-limit rejections can omit them. This describes existing header
    behavior,

    not a new quota policy.


    | Header | Description |

    |--------|-------------|

    | `X-RateLimit-Limit` | Maximum requests per window (`6000` for
    authenticated requests, `120` for unauthenticated). |

    | `X-RateLimit-Remaining` | Requests remaining in the current window. |

    | `X-RateLimit-Reset` | Unix timestamp when the window resets. |


    On a 429 for this case, an additional header is included:


    | Header | Description |

    |--------|-------------|

    | `Retry-After` | Number of seconds until the next request is safe. |


    The error body is `type: rate_limit_error` / `code: rate_limit_exceeded`.


    **Retry guidance:** This case is retryable. Honor `Retry-After` as the
    minimum wait, then apply exponential backoff with jitter for any retries
    beyond the first (cap at a few minutes; abandon after a small number of
    attempts to avoid retry storms). Do not retry tighter than `Retry-After`.


    ### Monthly per-company limit


    Each company has a monthly cap on total API calls, independent of the
    per-minute burst:


    | Plan | Monthly cap |

    |------|-------------|

    | Formation | 10 |

    | Startup | 300 |

    | Growth | 30,000 |

    | Enterprise | Unlimited |


    Enterprise is enabled internally by Finta for contract-managed companies. It
    bypasses

    commercial monthly API/MCP quotas and ordinary subscription lockouts, even
    when the

    Stripe subscription is absent or canceled. Requests and MCP tool calls are
    still counted.

    Enterprise does not bypass valid credentials, company/user permissions,
    company closure,

    request validation, payload bounds, or per-minute abuse limits. Disabling
    Enterprise restores

    ordinary plan gates using the current billing state; it does not change
    Stripe billing.


    Nothing counts until the company finishes onboarding, and `GET /onboarding`
    and `PATCH /onboarding`

    never count.


    Counts reset at **midnight Pacific Time (US & Canada)** on the 1st of each
    month. This is the Finta application's configured time zone; the cap is
    computed in that zone, not in UTC. Consumers in other time zones should
    convert the local-midnight Pacific boundary to their own clock; note that
    the absolute UTC offset shifts by one hour twice a year for daylight saving
    (PST is UTC-8, PDT is UTC-7). Blocked requests are not counted toward the
    limit. The error body is `type: limit_error` / `code:
    monthly_limit_exceeded`, and the `message` field includes the reset date in
    human-readable form.


    **Retry guidance:** This case is **not retryable in the short term.** No
    `Retry-After` header is sent, deliberately, because the only meaningful
    remediation is to upgrade the plan (Settings -> Plans at app.finta.com) or
    wait until the 1st of the next month. Naive retry loops should branch on
    `error.code` and stop retrying when they see `monthly_limit_exceeded`. SDKs
    that auto-retry on 429 should look at `error.code` (or the absence of
    `Retry-After`) before re-issuing.


    A temporary company limit override, set by Finta support for the current
    month, may change

    the allowance and the wording of the monthly-limit message. It applies to
    every user and

    API key in the company. The error code and no-short-term-retry rule remain
    unchanged.


    ## Pagination


    List endpoints use cursor-based pagination. Pass `limit` to control page
    size

    (default 100, max 500). To fetch the next page, pass `starting_after` with
    the

    `next_cursor` value from the previous response. Responses include `object:
    "list"`,

    `url` (the canonical path of the collection, relative to the API host),
    `has_more`

    (whether more results exist), `next_cursor` (an opaque value to pass
    unchanged as `starting_after`),

    and `data` (the page of items).


    ## Reporting dates and freshness


    Reports and category totals use calendar dates in **America/Los_Angeles
    (Pacific Time)**,

    including defaults such as today and the current quarter. Periodic requests
    include both

    `start_date` and `end_date` exactly. Point-in-time requests include activity
    through the

    exact `date`. Response dates identify the boundaries actually used, not
    rounded months.


    Whole months read whole-month rollups. The current month's first day through
    today in

    Pacific Time reads month-to-date (MTD) rollups when fresh. Other
    partial-month boundaries,

    including a midmonth start, read raw journal entries for just those partial
    months and are

    slower; any whole months in the same request still use rollups. Stale or
    unfilled MTD

    rollups safely fall back to raw entries. Whole-month requests and
    month-aligned

    month-start-to-today or year-to-date requests stay on the fast rollup path
    when MTD is fresh.


    Fresh MTD must end at exactly the requested cutoff. If a refresh advances
    the rollup

    across Pacific midnight during a request, exact live entries preserve the
    original

    cutoff; later-day MTD is never included in that answer.


    `refreshed_at` is a Unix timestamp covering the entire report, total, or
    grouped page,

    including partial months. For rollup-only reads it is the maximum
    contributing rollup

    timestamp, including MTD. Any live raw-entry portion is current as of the
    call, even when

    no raw entries match. A fresh MTD row contributes its timestamp even when it
    contains zero

    activity through today; future-only merchants do not appear as empty
    merchant groups.

    A grouped page covers its returned groups; a later month's refresh does not
    advance an

    earlier monthly page's timestamp.

    It is null only when no contributing timestamp or live raw read is

    available. Rollup-backed activity may lag newly imported or edited entries.


    ## Amounts


    Financial resource fields follow these two rules. Generic spreadsheet cell
    arrays are

    a scoped exception, described below:


    1. **Integer cents.** Monetary values are integers, never floats and never
    formatted strings. `$499.00` is `49900`. `$1,500.00` is `150000`. Divide by
    100 to get dollars. This avoids floating-point precision errors in financial
    calculations.

    2. **`_cents` suffix.** The field name always ends in `_cents` (e.g.
    `amount_cents`, `balance_cents`, `total_cents`, `net_income_cents`,
    `change_in_cash_cents`, `cash_cents`). If a field name does not end in
    `_cents`, it is not a monetary value.


    These rules apply to monetary resource fields (transactions, journal
    entries, income statement,

    balance sheet, cash flow). There is no "summary" or "display" sibling field
    that returns

    the same financial-resource amount in dollars or as a string.


    **Spreadsheet exception:** `/sheets` range `values` are generic spreadsheet
    cells, not

    financial-resource amount fields. They preserve the existing sheet engine's
    units: for

    example, a sheet amount of $20,000 is entered as `20000`, not `2000000`.
    Formatting does

    not trigger a cents conversion. Formula results use the existing spreadsheet
    evaluator

    and FINTA behavior. Do not apply the financial-resource cents convention to
    cell arrays.


    Sign conventions:


    - **Income statement**: revenue/income amounts are positive, expense amounts
    are negative. Summing every section's `total_cents` yields net income
    without sign-flipping.

    - **Balance sheet**: `balance_cents` carries the natural-sign cumulative
    balance for that account at the report date.

    - **Cash flow**: `amount_cents` is positive for cash inflows and negative
    for cash outflows.


    ## Errors


    Errors return a consistent JSON structure:


    ```json

    {
      "error": {
        "type": "invalid_request_error",
        "code": "resource_missing",
        "message": "The requested resource was not found.",
        "doc_url": "https://www.finta.com/docs/api-reference/errors#resource_missing"
      }
    }

    ```


    ### Status codes


    | Status | Meaning |

    |--------|---------|

    | `200 OK` | Request succeeded. |

    | `201 Created` | A new resource was created, such as an invitation, an
    account, or a transaction upload draft. |

    | `400 Bad Request` | Request was malformed or had invalid parameters. |

    | `401 Unauthorized` | The bearer credential is missing, malformed, or
    unrecognized. The fix is to obtain a valid API key. |

    | `403 Forbidden` | The API key is valid, but the caller does not have
    permission to access the resource. The fix is to regain the required company
    or product-area access. See the `Forbidden` response component for the
    specific codes. |

    | `404 Not Found` | The requested resource, or the endpoint itself, does not
    exist. Unknown or renamed paths (for example an old hyphenated report path
    like `/reports/income-statement` instead of `/reports/income_statement`)
    return this same envelope with `type: invalid_request_error` and `code:
    resource_missing`, as JSON, regardless of the `Accept` header. |

    | `409 Conflict` | The request conflicts with the resource's current state,
    for example changing an onboarding answer after Finta decided. |

    | `422 Unprocessable Entity` | Invitation data failed validation, for
    example an invalid email or a conflicting invitation or existing teammate. |

    | `429 Too Many Requests` | Either the per-minute burst rate limit
    (retryable, with `Retry-After`) or the monthly per-company API call limit
    (not retryable in the short term, no `Retry-After`). Branch on `error.code`
    to distinguish the two and avoid retry storms on monthly exhaustion. See the
    Rate Limits section for the full retry guidance. |

    | `5xx` | An unexpected error on Finta's side. Retry with exponential
    backoff. |


    The `error.type` and `error.code` fields are stable identifiers safe to
    switch on programmatically. The `error.message` is human-readable and may
    change without notice.


    ### Overdue billing invoices


    A company with an unpaid billing invoice explicitly linked by Finta loses
    access when

    that invoice's due date ends in America/Los_Angeles, independently of its
    subscription

    or plan. Every API endpoint then returns `403 permission_error` with code

    `invoice_overdue`, before running the endpoint or changing data. Pay all
    overdue linked

    invoices at app.finta.com or contact support@finta.com; replacing the API
    key or buying

    another plan does not resolve this refusal. There is no payment-processing
    grace period:

    payment must have settled and Stripe must mark each overdue invoice paid. A
    linked invoice only

    counts while its corresponding Enterprise product is enabled.


    Unpaid status can be cached for up to 60 seconds. Access returns
    automatically within

    a minute after every overdue linked invoice is paid. Paid status is final.
    Companies with no

    linked invoices do not perform this payment-status check.

    Amounts in the human-readable message reflect the unsettled balance after
    partial

    payments. Whole-dollar amounts omit decimal places; non-zero cents remain
    exact.

    Only invoice status paid clears an overdue invoice.

    The lock is not latched: when an overdue invoice is paid and the only
    remaining

    unpaid invoice is not due yet, access resumes until that later invoice
    misses its cutoff.


    If payment status cannot be verified after the due-date cutoff, every
    endpoint can

    instead return `503 api_error` with code `invoice_status_unavailable` and

    `Retry-After: 60`. Retry after that interval, then use bounded exponential
    backoff if

    the service remains unavailable. This response never treats an unknown
    payment as paid.

    A Stripe outage before the cutoff does not refuse access for this reason.


    MCP connections remain connected, but every tool call is refused for these
    same

    reasons, including tools that normally do not consume the monthly allowance.
    A refused

    tool result has `isError: true`, uses the API's message, and is not counted
    against the

    monthly allowance. Its transport remains HTTP 200; a temporary
    payment-status failure

    includes `Retry-After: 60` on that response.


    ### Early access endpoints


    Tags (`GET /tags`, `POST /tags`, `PATCH /tags/{id}`, `DELETE /tags/{id}`)
    and transaction `tag_id` writes and filters are in early access. Transaction
    `tag_id` and `tag_name` are null without access.


    Some endpoints are in early access: documented here, but turned on per
    company while they roll

    out. For a company that doesn't have one yet, every request to it returns
    `403 Forbidden` with

    `type: permission_error` and `code: feature_disabled`, ahead of the
    endpoint's own permission

    check, and changes nothing:


    ```json

    {
      "error": {
        "type": "permission_error",
        "code": "feature_disabled",
        "message": "This feature isn’t turned on for this company yet. Contact Finta to request access.",
        "doc_url": "https://www.finta.com/docs/api-reference/errors#feature_disabled"
      }
    }

    ```


    It is not retryable: contact Finta to request access for the company, then
    retry. Once

    the feature is on for the company the endpoint works normally, with no
    change to requests.
servers:
  - url: https://app.finta.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Onboarding
    description: Create a Finta account through an agent and verify the user's email
  - name: Sheets
    description: >
      Create, read, edit and delete spreadsheet documents, worksheets, cell
      ranges and embedded charts.

      Existing Sheets access includes tag-filtered financial formulas, including
      Other, without

      separate Dashboard, Transactions or Accounting settings access. API calls
      still require

      API access: Manage; reads require Forecast: View and mutations require
      Forecast: Manage,

      with existing company, subscription, financial authorization and
      tag-feature checks.

      Existing web link sharing requires Forecast: Manage and the existing
      sharing entitlement;

      the sharing owner's current access and revocation checks remain
      authoritative. Guests

      can evaluate authorized saved formulas, not arbitrary financial queries or
      the full tag

      catalog. This adds no public sharing or tag-management endpoint.
  - name: Onboarding
    description: >-
      Answer the onboarding questionnaire, follow Finta's decision, and connect
      the company's banks until it's onboarded
  - name: Company
    description: Retrieve company metadata
  - name: Plans & billing
    description: >-
      The plans Finta offers, what the company pays, and how much of each plan
      limit it has used.
  - name: Team
    description: Retrieve company members and manage invitations
  - name: Categories
    description: List your chart of accounts categories and add Finta's standard ones
  - name: Rules
    description: Company automation rule definitions.
  - name: Departments
    description: List the departments available to the authenticated company
  - name: Tags
    description: >-
      Company-defined transaction labels managed in Settings that break
      categories down further, such as Vercel and Webshare under Infrastructure.
      Each transaction has at most one tag; untagged amounts appear as Other.
      Tags do not change the books, taxes or reports. Early access.
  - name: Integrations
    description: List the authenticated company's integrations and their connection status
  - name: Inbox
    description: >-
      What Finta needs from the company, from its Finta inbox, and how each item
      gets done
  - name: Aggregations
    description: >-
      Compute totals for one category and its descendants, as a single figure or
      grouped by merchant or month
  - name: Transactions
    description: >
      Transactions are what your bank shows you: a single line like "AWS charged
      you $499."

      Most API consumers want transactions. For accounting-level detail, see
      Journal Entries.


      Amounts are in cents (e.g. `amount_cents: 49900` = $499.00).
  - name: Journal Entries
    description: >
      Journal entries are the accounting records that transactions create. A
      single $499 AWS

      charge becomes two journal entries: debit Software $499, credit Cash $499
      (double-entry

      bookkeeping). Use journal entries when you need accounting-level detail.


      Amounts are in cents (e.g. `amount_cents: 49900` = $499.00).
  - name: Invoices
    description: >
      Invoices the company sent, and the bank deposits that paid them. Recording
      an invoice books

      its revenue; Finta doesn't send invoices to customers.


      Amounts are in cents (e.g. `amount_cents: 49900` = $499.00).
  - name: Parties
    description: Discover observed counterparties for category-scoped financial queries.
  - name: Forms
    description: Discover vendor compliance filing records and yearly progress.
  - name: Reports
    description: >
      Financial statements: income statement, balance sheet, and cash flow. Each
      report

      returns the complete statement for a single period. You cannot filter to
      one category

      or request multiple periods in one call.
  - name: Feedback
    description: Send questions, feedback and bug reports to Finta support
  - name: Tax Credits
    description: Credit amounts and claim progress by type, jurisdiction, and tax year
  - name: Taxes
    description: >-
      Discover income-tax and Delaware franchise-tax filing records and
      available PDFs.
  - name: Files
    description: Upload the PDFs that tax uploads attach to the company's tax records.
paths:
  /signups:
    post:
      tags:
        - Onboarding
      summary: Create signup
      description: >
        First time using Finta: call this endpoint with their email and `app` if
        known.

        Before signup, use what you can already reach (chat, local files, `git
        config user.email`,

        connected tools) to gather context, within the permissions they've given
        you; propose the

        email with its source; ask only if none is found. Gather incorporation
        year,

        entity type, state, what they sell, foreign subsidiaries (now or soon),
        banks, credit cards.

        Send one message with the email and prefilled answers, their sources,
        conflicts and missing

        questions (start with year/entity/state if nothing is known). Confirm
        together; ask if first

        time only if not already known. Already uses Finta: skip signup and sign
        in.

        No API key, company or OAuth grant is needed. Existing accounts get the
        same 202 and no email.

        New accounts receive a verification link; pending accounts receive a
        replacement link

        that invalidates the previous one. Links expire after one hour. Active,
        inactive and deleted

        accounts receive no email. Every account state returns the identical 202
        response and

        consumes the same email allowance, so neither responses nor 429s reveal
        account existence.

        If no account exists and the email has a pending team invitation, resend
        that invitation

        instead of creating an owner account. This uses the same signup
        allowance and 202 response.

        `verification_sent` is an instruction, not confirmation that an email
        was delivered.

        Every admitted request queues the same background job. After an
        allowance is consumed,

        account creation, resend and mailer failures are reported internally and
        still

        return the same 202 response for every account state; the allowance is
        not refunded.

        Success confirms neither account creation nor email delivery. The kill
        switch, email

        validation and rate-limit checks retain their documented error
        responses.


        Follow `next_step.message`: the user clicks Activate in Finta's email in
        their own

        browser; never fetch the link. Then connect Finta's MCP (`mcp_url`) the
        way your app

        supports; they sign in with one Allow. If your app must restart to load
        it, tell them

        exactly how to restart and come back to this chat, and call no Finta
        tool until then.

        E.g. Codex CLI: they quit (Ctrl+C twice) and run

        `codex mcp add finta --url <mcp_url> && codex resume --last` (don't run
        it yourself);

        Claude Code: run `claude mcp add --transport http finta <mcp_url>` if
        you haven't,

        then they run /mcp and pick finta. Once connected, call `get_onboarding`
        and follow `next_step.message`.

        No email? Existing accounts get none; just connect and sign in.

        Activating an agent-issued link replaces any pending-account password
        with a new random one, including a password chosen

        during a prior web signup. Requesting or opening the link does not
        change that password.

        There is no status or verify endpoint.


        This endpoint bypasses company permissions, onboarding, monthly limits
        and request logging.

        It always uses the unauthenticated 120 requests/minute per-IP limit,
        even with a credential.

        Signup verification also allows 3 attempts per recipient per 30 minutes
        and 5 per 24 hours,

        and 10 auth emails per IP per 10 minutes and 100 per 24 hours (IP limits
        shared across auth

        email purposes). MCP signup enforces these same recipient and caller-IP
        email limits,

        including provider egress IPs; User-Agent branding does not grant an
        exemption.

        A 429 includes Retry-After in seconds; wait that long before retrying.

        Repeating a request renews a pending link and consumes an attempt.
        Rollout is off by default;

        while paused, use the web signup URL in the 503 message.
      operationId: createSignup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignupRequest'
            example:
              email: founder@acme.com
              app: codex
      responses:
        '202':
          description: >-
            Identical verification instructions for every account state; does
            not disclose delivery or account existence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Signup'
              example:
                status: verification_sent
                email: founder@acme.com
                expires_in_seconds: 3600
                mcp_url: https://mcp.finta.com/mcp
                next_step:
                  action: open_verification_link
                  message: >-
                    Tell the user: "Click Activate in the email Finta just sent
                    you at founder@acme.com." They click it in their own
                    browser; never fetch the link. Then connect Finta's MCP
                    (https://mcp.finta.com/mcp) the way your app supports; they
                    sign in with one Allow. If your app must restart to load it,
                    tell them exactly how to restart and come back to this chat,
                    and call no Finta tool until then. E.g. Codex CLI: they quit
                    (Ctrl+C twice) and run `codex mcp add finta --url
                    https://mcp.finta.com/mcp && codex resume --last` (don't run
                    it yourself); Claude Code: run `claude mcp add --transport
                    http finta https://mcp.finta.com/mcp` if you haven't, then
                    they run /mcp and pick finta. Once connected, call
                    get_onboarding and follow next_step.message. No email?
                    Existing accounts get none; just connect and sign in.
        '400':
          description: >-
            The required email parameter is missing or blank
            (parameter_missing).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: invalid_request_error
                  code: parameter_missing
                  message: 'Missing required param: email.'
                  param: email
                  doc_url: >-
                    https://www.finta.com/docs/api-reference/errors#parameter_missing
        '422':
          description: Email does not pass Finta's email validation (invalid_email).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: invalid_request_error
                  code: invalid_email
                  message: Enter a valid email address.
                  param: email
                  doc_url: >-
                    https://www.finta.com/docs/api-reference/errors#invalid_email
        '429':
          description: >-
            Per-IP request limit or signup verification email allowance
            exceeded. Every account state consumes the same allowance.
          headers:
            Retry-After:
              description: >-
                Seconds to wait before retrying, whether limited by request
                volume or an email allowance.
              schema:
                type: string
                pattern: ^[0-9]+$
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limit_error
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Please retry after the Retry-After
                    period.
                  doc_url: >-
                    https://www.finta.com/docs/api-reference/errors#rate_limit_exceeded
        '503':
          description: >-
            Signup through AI apps is temporarily paused (signups_paused); use
            the web signup page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: signups_paused
                  message: >-
                    Sign-up through AI apps is paused. The user can sign up at
                    https://app.finta.com/signup.
                  doc_url: >-
                    https://www.finta.com/docs/api-reference/errors#signups_paused
      security: []
components:
  schemas:
    SignupRequest:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          format: email
          maxLength: 254
          description: >-
            The user's email as supplied by them. Never guess. Finta trims
            whitespace and lowercases it.
        app:
          type: string
          description: >-
            Optional branding for the verification email and page. Supported
            keys are codex, claude, claude-desktop, claude-code, chatgpt,
            ari-from-ariso, cursor, grok-bot, capy, hermes-agent, mem0-gateway,
            codevisor, crevio, and mcp-inspector. When omitted, Finta detects
            the app from User-Agent. Unknown values use generic agent branding
            and do not cause an error. This only affects branding, not signup
            behavior.
    Signup:
      type: object
      required:
        - status
        - email
        - expires_in_seconds
        - mcp_url
        - next_step
      properties:
        status:
          type: string
          enum:
            - verification_sent
          description: >-
            Same value for every account state; does not confirm that an email
            was sent.
        email:
          type: string
          format: email
          description: The submitted email, trimmed and lowercased.
        expires_in_seconds:
          type: integer
          enum:
            - 3600
          description: >-
            Lifetime of a verification link when one is issued. Present even
            when no email is sent.
        mcp_url:
          type: string
          format: uri
          description: >-
            Finta's OAuth-only MCP resource URL, configured for this
            environment.
        next_step:
          type: object
          required:
            - action
            - message
          properties:
            action:
              type: string
              enum:
                - open_verification_link
            message:
              type: string
              description: >-
                Instructions for human activation, MCP connection, and returning
                to the conversation after any required restart.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - doc_url
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - permission_error
                - invalid_request_error
                - rate_limit_error
                - limit_error
                - api_error
              description: >-
                The error category. `authentication_error` (401) means the
                bearer credential was missing, malformed, or unrecognized.
                `permission_error` (403) means the credential was valid but the
                caller is not allowed to access the resource.
                `invalid_request_error` covers invalid parameters, unavailable
                resources, invitation validation failures, and requests that
                conflict with current state (409). `rate_limit_error` is for
                per-minute burst limits or signup email limits (wait for
                Retry-After). `limit_error` is for monthly API call limits per
                company (upgrade or wait for reset). `api_error` denotes an
                operation failure on the server (500), or temporarily
                unavailable rule definitions (503 rules_not_ready), or paused
                agent signup (503 signups_paused). Retry with exponential
                backoff; persistent 503 errors require operator attention.
            code:
              type: string
              enum:
                - invalid_api_key
                - user_inactive
                - user_removed_from_company
                - company_closed
                - subscription_required
                - invoice_overdue
                - invoice_status_unavailable
                - staging_access_denied
                - insufficient_permission
                - resource_missing
                - parameter_missing
                - invalid_email
                - signups_paused
                - category_update_failed
                - transaction_update_failed
                - rate_limit_exceeded
                - monthly_limit_exceeded
                - invalid_date_range
                - invalid_date
                - invalid_request
                - idempotency_key_conflict
                - plan_upgrade_required
                - request_required
                - feature_disabled
                - invitation_invalid
                - invitation_create_failed
                - permissions_update_failed
                - invitation_resend_failed
                - invitation_revoke_failed
                - integration_not_connectable
                - integration_already_connected
                - connect_link_in_progress
                - connect_link_failed
                - rules_not_ready
                - forms_not_ready
                - taxes_not_ready
                - rule_already_exists
                - rule_busy
                - tag_already_exists
                - tag_busy
                - tag_deletion_failed
                - revision_conflict
                - revision_history_mismatch
                - rule_deletion_failed
                - account_create_failed
                - category_create_failed
                - upload_committed
                - upload_commit_failed
                - feedback_unavailable
                - billing_unavailable
                - closed_books
                - invoice_already_exists
                - invoice_not_open
                - invoice_not_matched
                - payment_already_matched
                - transaction_not_matchable
                - invoice_operation_failed
                - transaction_already_matched
                - transfer_not_eligible
                - transfer_operation_failed
                - transaction_already_split
                - transaction_not_splittable
                - transaction_not_split
                - split_operation_failed
                - report_export_failed
                - report_export_limit_exceeded
                - invalid_file
                - wrong_document_type
                - file_already_attached
                - tax_upload_not_allowed
                - tax_upload_failed
                - inbox_item_not_completable
                - inbox_item_complete_failed
                - onboarding_incomplete
                - answers_incomplete
                - onboarding_locked
                - onboarding_complete
              description: A specific error code.
            message:
              type: string
              description: A human-readable description of the error.
            doc_url:
              type: string
              format: uri
              description: A link to documentation about this error.
              example: https://www.finta.com/docs/api-reference/errors#invalid_api_key
            current_revision:
              type: integer
              minimum: 0
              description: >-
                Current sheet revision, returned on a revision conflict when
                available.
            param:
              type: string
              nullable: true
              description: The parameter that caused the error, if applicable.
            missing:
              type: array
              items:
                type: string
              description: >-
                With `answers_incomplete`, the onboarding answer keys still
                required before submitting.
            onboarding_status:
              type: string
              enum:
                - questionnaire
                - ready_to_submit
                - call_required
                - not_eligible
                - connect_banks
                - syncing
                - complete
              description: >-
                With `onboarding_incomplete`, where the company is in
                onboarding, as `GET /onboarding` returns it in `status`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key prefixed with `finta_`

````

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