Track · Schema

OnboardingList

MusicFintechRoyaltiesPaymentsBanking

Properties

Name Type Description
enabled boolean
can_manage boolean
provider_name string
results array
View JSON Schema on GitHub

JSON Schema

track-onboarding-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/track/json-schema/track-onboarding-list-schema.json",
  "title": "OnboardingList",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/track-payments-api-openapi.yml#/components/schemas/OnboardingList",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "can_manage": {
      "type": "boolean"
    },
    "provider_name": {
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Onboarding"
      }
    }
  },
  "required": [
    "can_manage",
    "enabled",
    "provider_name",
    "results"
  ],
  "$defs": {
    "CustomerTypeEnum": {
      "enum": [
        "individual",
        "business"
      ],
      "type": "string",
      "description": "* `individual` - Individual\n* `business` - Business"
    },
    "Onboarding": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "customer_type": {
          "$ref": "#/$defs/CustomerTypeEnum"
        },
        "customer_ref": {
          "type": [
            "string",
            "null"
          ]
        },
        "snapshot": {
          "$ref": "#/$defs/OnboardingState"
        },
        "observed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "customer_ref",
        "customer_type",
        "email",
        "id",
        "name",
        "observed_at",
        "snapshot"
      ]
    },
    "OnboardingState": {
      "type": "object",
      "properties": {
        "next_action": {
          "$ref": "#/$defs/OnboardingStateNextActionEnum"
        },
        "agreements": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RequiredAgreement"
          }
        },
        "verification": {
          "allOf": [
            {
              "$ref": "#/$defs/Verification"
            }
          ]
        },
        "feedback": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "unresolved_operation": {
          "type": "boolean"
        }
      },
      "required": [
        "agreements",
        "feedback",
        "next_action",
        "unresolved_operation",
        "verification"
      ]
    },
    "OnboardingStateNextActionEnum": {
      "enum": [
        "correct_registration",
        "accept_agreement",
        "start",
        "resume",
        "wait",
        "complete",
        "support",
        "restart"
      ],
      "type": "string",
      "description": "* `correct_registration` - correct_registration\n* `accept_agreement` - accept_agreement\n* `start` - start\n* `resume` - resume\n* `wait` - wait\n* `complete` - complete\n* `support` - support\n* `restart` - restart"
    },
    "RequiredAgreement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        }
      },
      "required": [
        "display_name",
        "id",
        "url"
      ]
    },
    "Verification": {
      "type": "object",
      "properties": {
        "reference": {
          "type": "string"
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "reason": {
          "type": "string"
        }
      },
      "required": [
        "reason",
        "reference",
        "url"
      ]
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/track-onboarding-list"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.