REST API›Enterprise›Reports

POST

Generate report

Creates a new report in pending status.

Body Params

object

Restricted request body for the enterprise-scoped report-create endpoints (POST /api/v2/reports and its /admin/enterprise variant). Narrows type to only the values accepted at runtime by validateReportParams, so the OpenAPI/dev-docs contract matches the controller behavior.
  • type string enum required
    holdingstransactionstradesstakingholdingsByAddressuserAccesspoliciescostBasis
  • format string enum required
    csvpdf
  • holdings object
    Holdings report
    holdings object
    • byWallet boolean
    • enterprise string required
      ID of the enterprise

      at least 1 characters · matches ^[0-9a-f]{32}$

    • includeStaking boolean
    • snapshotDate string date-time required
      Date of the snapshot
  • transactions object
    Transactions report
    transactions object
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • isAddressReport boolean
    • isDetailed boolean
    • startDate string date-time required
      Date of the snapshot
    • wallets array of strings
    • walletTypes array of strings
  • quarterly object
    Quarterly report
    quarterly object
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • startDate string date-time required
      Date of the snapshot
  • trades object
    Trades report
    trades object
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • isCostBasisReport boolean
    • isFillsReport boolean
    • startDate string date-time required
      Date of the snapshot
  • staking object
    Staking report
    staking object
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • isBalanceReport boolean
    • startDate string date-time required
      Date of the snapshot
    • wallets array of strings
    • walletTypes array of strings
  • holdingsByAddress object
    Address-level Holdings report
    holdingsByAddress object
    • assets array of strings
    • enterprise string required

      at least 1 characters

    • snapshotDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationHoldings object
    Organization-level Holdings report
    organizationHoldings object
    • byWallet boolean
    • enterprises array of strings
    • includeStaking boolean
    • organization string required

      at least 1 characters

    • snapshotDate string date-time required
  • organizationTransactions object
    Organization-level Transactions report
    organizationTransactions object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isAddressReport boolean
    • isDetailed boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationHoldingsV2 object
    Organization-level Holdings report (v2 — reconciled/persisted marts dataset). Only by-wallet holdings are available for v2; byWallet: false is rejected by the server and byWallet is otherwise always treated as true. Use organizationHoldings (v1) for org-level (non-per-wallet) holdings.
    organizationHoldingsV2 object
    • byWallet boolean
    • enterprises array of strings
    • includeStaking boolean
    • organization string required

      at least 1 characters

    • snapshotDate string date-time required
  • organizationTransactionsV2 object
    Organization-level Transactions report (v2 — reconciled/persisted marts dataset). Only transaction history is available for v2; isDetailed and isAddressReport are rejected by the server. Use organizationTransactions (v1) for transfer-detail or address-level-transfer-detail reports.
    organizationTransactionsV2 object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isAddressReport boolean
    • isDetailed boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationHoldingsByAddress object
    Organization-level Holdings by Address report
    organizationHoldingsByAddress object
    • assets array of strings
    • enterprises array of strings
    • organization string required

      at least 1 characters

    • snapshotDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationStaking object
    Organization-level Staking report
    organizationStaking object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isBalanceReport boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationTrades object
    Organization-level Trades report
    organizationTrades object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isFillsReport boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
  • userAccess object
    Organization-level User Access Review report (DE-519)
    userAccess object
    • allEnterprises boolean
    • asOfDate string date-time required
    • enterprises array of strings
    • organization string required

      at least 1 characters

    • reportContents string enum required
      membersroles
  • policies object
    Policies report
    policies object
    • completeHistory boolean
    • enterprise string required

      at least 1 characters

  • costBasis object deprecated
    costBasis object
    • account string
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • startDate string date-time required
      Date of the snapshot

Responses

200
OK

Response Body

object

  • holdings object
    Holdings report
    holdings object
    • byWallet boolean
    • enterprise string required
      ID of the enterprise

      at least 1 characters · matches ^[0-9a-f]{32}$

    • includeStaking boolean
    • snapshotDate string date-time required
      Date of the snapshot
  • transactions object
    Transactions report
    transactions object
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • isAddressReport boolean
    • isDetailed boolean
    • startDate string date-time required
      Date of the snapshot
    • wallets array of strings
    • walletTypes array of strings
  • quarterly object
    Quarterly report
    quarterly object
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • startDate string date-time required
      Date of the snapshot
  • trades object
    Trades report
    trades object
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • isCostBasisReport boolean
    • isFillsReport boolean
    • startDate string date-time required
      Date of the snapshot
  • staking object
    Staking report
    staking object
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • isBalanceReport boolean
    • startDate string date-time required
      Date of the snapshot
    • wallets array of strings
    • walletTypes array of strings
  • holdingsByAddress object
    Address-level Holdings report
    holdingsByAddress object
    • assets array of strings
    • enterprise string required

      at least 1 characters

    • snapshotDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationHoldings object
    Organization-level Holdings report
    organizationHoldings object
    • byWallet boolean
    • enterprises array of strings
    • includeStaking boolean
    • organization string required

      at least 1 characters

    • snapshotDate string date-time required
  • organizationTransactions object
    Organization-level Transactions report
    organizationTransactions object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isAddressReport boolean
    • isDetailed boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationHoldingsV2 object
    Organization-level Holdings report (v2 — reconciled/persisted marts dataset). Only by-wallet holdings are available for v2; byWallet: false is rejected by the server and byWallet is otherwise always treated as true. Use organizationHoldings (v1) for org-level (non-per-wallet) holdings.
    organizationHoldingsV2 object
    • byWallet boolean
    • enterprises array of strings
    • includeStaking boolean
    • organization string required

      at least 1 characters

    • snapshotDate string date-time required
  • organizationTransactionsV2 object
    Organization-level Transactions report (v2 — reconciled/persisted marts dataset). Only transaction history is available for v2; isDetailed and isAddressReport are rejected by the server. Use organizationTransactions (v1) for transfer-detail or address-level-transfer-detail reports.
    organizationTransactionsV2 object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isAddressReport boolean
    • isDetailed boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationHoldingsByAddress object
    Organization-level Holdings by Address report
    organizationHoldingsByAddress object
    • assets array of strings
    • enterprises array of strings
    • organization string required

      at least 1 characters

    • snapshotDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationStaking object
    Organization-level Staking report
    organizationStaking object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isBalanceReport boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
    • wallets array of strings
    • walletTypes array of strings
  • organizationTrades object
    Organization-level Trades report
    organizationTrades object
    • assets array of strings
    • endDate string date-time required
    • enterprises array of strings
    • isFillsReport boolean
    • organization string required

      at least 1 characters

    • startDate string date-time required
  • userAccess object
    Organization-level User Access Review report (DE-519)
    userAccess object
    • allEnterprises boolean
    • asOfDate string date-time required
    • enterprises array of strings
    • organization string required

      at least 1 characters

    • reportContents string enum required
      membersroles
  • policies object
    Policies report
    policies object
    • completeHistory boolean
    • enterprise string required

      at least 1 characters

  • costBasis object deprecated
    costBasis object
    • account string
    • assets array of strings
    • endDate string date-time required
      Date of the snapshot
    • enterprise string required

      at least 1 characters · matches ^[0-9a-f]{32}$

    • startDate string date-time required
      Date of the snapshot
  • id string required

    at least 1 characters · matches ^[0-9a-f]{32}$

  • type string enum required
    Type of report
    holdingstransactionstradesstakingholdingsByAddressuserAccesspoliciescostBasisorganizationHoldingsorganizationHoldingsByAddressorganizationTransactionsorganizationTradesorganizationStakingorganizationHoldingsV2organizationTransactionsV2quarterly
  • format string enum required
    Format of report
    csvpdf
  • status string enum required
    Status of report
    pendingprocessingcompletedfailed
  • createdAt string date-time required
    Date report was created
  • completedAt string date-time
    Date report was completed
  • documentName string
    Name of the report document

    at least 1 characters

  • user string required
    ID of the user who requested the report

    at least 1 characters · matches ^[0-9a-f]{32}$

400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
500
Internal Server Error

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id