Upvest · JSON Structure

Investment Api Account Structure

An investment account that holds positions and tracks balances.

Type: object Properties: 7
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

Account is a JSON Structure definition published by Upvest, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id user_id account_group_id type status created_at updated_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/upvest/refs/heads/main/json-structure/investment-api-account-structure.json",
  "name": "Account",
  "description": "An investment account that holds positions and tracks balances.",
  "type": "object",
  "properties": {
    "id": {
      "type": "uuid",
      "description": "The unique identifier of the account.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "user_id": {
      "type": "uuid",
      "description": "The user who owns this account.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "account_group_id": {
      "type": "uuid",
      "description": "The account group this account belongs to.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "type": {
      "type": "string",
      "description": "The type of investment account.",
      "example": "standard"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "OPEN",
        "CLOSING",
        "CLOSED"
      ],
      "description": "The current status of the account.",
      "example": "PENDING"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the account was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "description": "When the account was last updated.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}