betteroff-finance Onboarding API

The onboarding API from betteroff-finance — 5 operation(s) for onboarding.

Operations 5

POST /onboarding/welcome/holdings Post onboarding welcome holdings #
POST /onboarding/welcome/skip Post onboarding welcome skip #
POST /onboarding/bank-pick Post onboarding bank pick #
POST /onboarding/heard-about Post onboarding heard about #
POST /onboarding/setup-checklist/hide Post onboarding setup checklist hide #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/betteroff-finance:betteroff-finance-onboarding-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

betteroff-finance-onboarding-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: BetterOff Onboarding API
  version: 0.5.0+cd65185c
servers:
- url: https://api.betteroff.finance
tags:
- name: Onboarding
paths:
  /onboarding/welcome/holdings:
    post:
      operationId: postOnboardingWelcomeHoldings
      tags:
      - Onboarding
      security:
      - session: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                holdings:
                  minItems: 1
                  maxItems: 5
                  type: array
                  items:
                    type: string
                    enum:
                    - crypto
                    - bank
                    - investments
                    - property
                    - debts
              required:
              - holdings
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post onboarding welcome holdings
      x-summary-source: derived
  /onboarding/welcome/skip:
    post:
      operationId: postOnboardingWelcomeSkip
      tags:
      - Onboarding
      security:
      - session: []
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post onboarding welcome skip
      x-summary-source: derived
  /onboarding/bank-pick:
    post:
      operationId: postOnboardingBankPick
      tags:
      - Onboarding
      security:
      - session: []
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post onboarding bank pick
      x-summary-source: derived
  /onboarding/heard-about:
    post:
      operationId: postOnboardingHeardAbout
      tags:
      - Onboarding
      security:
      - session: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                source:
                  type: string
                  enum:
                  - dismissed
                  - google
                  - ai_chat
                  - x
                  - reddit
                  - crypto_community
                  - youtube
                  - podcast_news
                  - friend
                  - newsletter
                  - app_directory
                  - other
              required:
              - source
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post onboarding heard about
      x-summary-source: derived
  /onboarding/setup-checklist/hide:
    post:
      operationId: postOnboardingSetupChecklistHide
      tags:
      - Onboarding
      security:
      - session: []
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post onboarding setup checklist hide
      x-summary-source: derived
components:
  schemas:
    ProblemDetails:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        type:
          type: string
          description: Always "about:blank"; branch on `code`.
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        detail:
          type: string
        code:
          type: string
          description: Stable UPPER_SNAKE code.
        error:
          type: string
          description: Older clients' copy of `detail`.
        message:
          type: string
          description: Older clients' copy of `detail`.
        requestId:
          description: Diagnostic only; quote it to support.
          type: string
        instance:
          type: string
        details:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
      required:
      - type
      - title
      - status
      - detail
      - code
      - error
      - message
      additionalProperties: {}
      description: RFC 9457 problem details. Some refusals add fields; ignore ones you don't know.
  securitySchemes:
    session:
      type: http
      scheme: bearer
      description: 'The BetterOff app acting for its signed-in user. Not available to integrations: Better Auth session tokens and browser session cookies are rejected. Use an API token or agent OAuth.'
    apiToken:
      type: http
      scheme: bearer
      description: Personal API token (bo_pat_), created in BetterOff settings with the scopes it may use.
    agentOAuth:
      type: openIdConnect
      openIdConnectUrl: https://app.betteroff.finance/api/auth/.well-known/openid-configuration
      description: Agent OAuth grant; the same token and scopes as /mcp.