Business

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/agentaos-ai/json-schema/agentaos-ai-business-schema.json",
  "title": "Business",
  "description": "A business you manage: a client's business, or another app of your own company. Every field is camelCase on the wire.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/agentaos-ai-businesses-api-openapi.yml#/components/schemas/Business",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Business UUID. Send it in `AgentaOS-Account` to act as the business."
    },
    "name": {
      "type": "string",
      "description": "The name buyers see."
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "ISO 3166-1 alpha-2."
    },
    "status": {
      "type": "string",
      "enum": [
        "test_only",
        "in_review",
        "changes_needed",
        "on_hold",
        "rejected",
        "live"
      ],
      "description": "Where the business stands. `live` = verified. A bank account is needed before the first payout, not for this status. `changes_needed` = we asked the business for a change."
    },
    "platformOrgId": {
      "type": "string",
      "format": "uuid",
      "description": "Your own id: the platform that manages it."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "platformFee": {
      "type": "object",
      "description": "Your share of its new sales, set in the dashboard: basis points of the price before VAT (`1000` = 10%) plus a fixed amount in minor units.",
      "properties": {
        "bps": {
          "type": "integer"
        },
        "fixedMinor": {
          "type": "integer"
        },
        "fixedDisplay": {
          "type": "string",
          "description": "The fixed part as money, in the currency of this month's fees, else euros: `€0.30`."
        }
      },
      "required": [
        "bps",
        "fixedMinor",
        "fixedDisplay"
      ]
    },
    "sameLegalEntity": {
      "type": "boolean",
      "description": "`true` for another app of your own company: verified and priced with you, no share, no identity check of its own."
    },
    "feesThisMonth": {
      "type": "array",
      "description": "Your share of its live sales this month, per currency. `feesDisplay` is ready to show.",
      "items": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string"
          },
          "feesMinor": {
            "type": "integer"
          },
          "feesDisplay": {
            "type": "string"
          }
        },
        "required": [
          "currency",
          "feesMinor",
          "feesDisplay"
        ]
      }
    },
    "invitedEmail": {
      "type": [
        "string",
        "null"
      ],
      "description": "Who an open invitation is waiting on, or null."
    },
    "identityVerified": {
      "type": "boolean",
      "description": "The identity check is done: its own, or your company's for another app of your own company."
    }
  },
  "required": [
    "id",
    "name",
    "country",
    "status",
    "platformOrgId",
    "createdAt",
    "platformFee",
    "sameLegalEntity",
    "feesThisMonth",
    "invitedEmail",
    "identityVerified"
  ]
}