Upvest · JSON Structure

Investment Api Report Structure

A generated user-facing report or statement.

Type: object Properties: 5
Banking InfrastructureFintechInvestmentsSecuritiesFractional InvestingCustodyWealth Management

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

Properties

id type status file_id created_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-report-structure.json",
  "name": "Report",
  "description": "A generated user-facing report or statement.",
  "type": "object",
  "properties": {
    "id": {
      "type": "uuid",
      "description": "The report identifier.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "type": {
      "type": "string",
      "description": "The report type.",
      "example": "standard"
    },
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "READY",
        "FAILED"
      ],
      "description": "The report generation status.",
      "example": "PENDING"
    },
    "file_id": {
      "type": "uuid",
      "description": "The file identifier for downloading the report.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the report was generated.",
      "example": "2025-03-15T14:30:00Z"
    }
  }
}