# Upvest Investment API Upvest Investment API. Version: 1.75.0 License: Apache 2.0 ## Servers Sandbox environment ``` https://sandbox.upvest.co ``` Live environment ``` https://api.upvest.co ``` ## Security ### oauth-client-credentials Type: oauth2 ## Download OpenAPI description [Upvest Investment API](https://docs.upvest.co/_bundle/api.yaml) ## Access Tokens All authentication related paths. ### Get an access token for requested scopes - [POST /auth/token](https://docs.upvest.co/api/access-tokens/issue_token.md): Get an access token to use with the API with specified scopes. You should _always_ scope your access tokens. You get one for read-access and separate ones for updating, creating or deleting resources. ## Users All user related paths. ### Get all users - [GET /users](https://docs.upvest.co/api/users/list_users.md): Returns the list of all users. ### Create a user - [POST /users](https://docs.upvest.co/api/users/create_user.md): Creates a user. ### Get a user by ID - [GET /users/{user_id}](https://docs.upvest.co/api/users/retrieve_user.md): Returns the user specified by ID. ### Offboard a user - [DELETE /users/{user_id}](https://docs.upvest.co/api/users/offboard_user.md): Starts the user offboarding process in the background. ### Change user data - [POST /users/{user_id}/data_change_requests](https://docs.upvest.co/api/users/user_data_change.md): Requests a data change for a user specified by ID. ### Users events - [POST Users events](https://docs.upvest.co/api/users/user_event.md): Users events ## User Identifiers All user identifiers related paths. ### Get user identifiers - [GET /users/{user_id}/identifiers](https://docs.upvest.co/api/user-identifiers/list_user_identifiers.md): Lists all existing identifiers of a user used for transaction reporting. ### Create a user identifier - [POST /users/{user_id}/identifiers](https://docs.upvest.co/api/user-identifiers/create_identifier.md): Creates a new identifier for a user that will be used for transaction reporting obligations. This identifier is required for user activation if the user's nationalities do not allow reporting using the CONCAT format. More information can be found in the guides. ### Get a user identifier by ID - [GET /users/{user_id}/identifiers/{identifier_id}](https://docs.upvest.co/api/user-identifiers/retrieve_identifier.md): Returns an existing identifier of a given user used for transaction reporting. ### Update a user identifier by ID - [PATCH /users/{user_id}/identifiers/{identifier_id}](https://docs.upvest.co/api/user-identifiers/update_identifier.md): Updates an existing identifier of a given user used for transaction reporting. ## User Checks All user checks related paths. ### Get checks for a user - [GET /users/{user_id}/checks](https://docs.upvest.co/api/user-checks/list_user_checks.md): Lists all checks for a user specified by ID. ### Create a new check for a user - [POST /users/{user_id}/checks](https://docs.upvest.co/api/user-checks/create_user_check.md): Creates a new check for a user specified by ID. ### Get a user check by ID - [GET /users/{user_id}/checks/{check_id}](https://docs.upvest.co/api/user-checks/retrieve_user_check.md): Retrieves a check for a user specified by its ID. ### User checks events - [POST User checks events](https://docs.upvest.co/api/user-checks/user_checks_event.md): User checks events ## Accounts All accounts related paths ### Get user accounts - [GET /users/{user_id}/accounts](https://docs.upvest.co/api/accounts/list_user_accounts.md): Lists the accounts of a user specified by ID. ### Get account by ID - [GET /accounts/{account_id}](https://docs.upvest.co/api/accounts/retrieve_account.md): Returns the account specified by its ID. ### Update account by ID - [PATCH /accounts/{account_id}](https://docs.upvest.co/api/accounts/update_account.md): Updates the account specified by its ID. ### Close account by ID - [DELETE /accounts/{account_id}](https://docs.upvest.co/api/accounts/account_closure.md): Initiates the closure request for an account specified by its ID. ### Get accounts - [GET /accounts](https://docs.upvest.co/api/accounts/list_accounts.md): Returns a list of all accounts. ### Create an account - [POST /accounts](https://docs.upvest.co/api/accounts/create_account.md): Creates an account. ### Account events - [POST Account events](https://docs.upvest.co/api/accounts/account_event.md): Account events ## Account Groups All account groups related paths ### Get user account groups - [GET /users/{user_id}/account_groups](https://docs.upvest.co/api/account-groups/list_user_account_groups.md): Lists the account groups of a user specified by ID. ### Get an account group by ID - [GET /account_groups/{account_group_id}](https://docs.upvest.co/api/account-groups/retrieve_account_group.md): Returns the account group specified by its ID. ### Close an account group by ID - [DELETE /account_groups/{account_group_id}](https://docs.upvest.co/api/account-groups/account_group_closure.md): Initiates the closure request for an account group specified by its ID. ### Get account groups - [GET /account_groups](https://docs.upvest.co/api/account-groups/list_account_groups.md): Returns a list of all account groups. ### Create an account group - [POST /account_groups](https://docs.upvest.co/api/account-groups/create_account_group.md): Creates an account group. ### Account group events - [POST Account Group events](https://docs.upvest.co/api/account-groups/account_group_event.md): Account group events ## Tax Residencies All tax residencies related paths. ### Retrieve tax residencies - [GET /users/{user_id}/tax_residencies](https://docs.upvest.co/api/tax-residencies/retrieve_tax_residencies.md): Retrieve tax residencies ### Update tax residencies - [POST /users/{user_id}/tax_residencies](https://docs.upvest.co/api/tax-residencies/set_tax_residencies.md): Update tax residencies ## Corporate Actions All Corporate Action related paths. ### Corporate action events - [POST Corporate action events](https://docs.upvest.co/api/corporate-actions/corporate_action_event.md): Corporate action events ## Tax Exemptions All tax exemptions related paths ### Create a tax exemption - [POST /tax_exemptions](https://docs.upvest.co/api/tax-exemptions/create_tax_exemption.md): Creates a tax exemption. ### Get a tax exemption by ID - [GET /tax_exemptions/{tax_exemption_id}](https://docs.upvest.co/api/tax-exemptions/retrieve_tax_exemption_by_id.md): Returns the tax exemption specified by its ID ### Update a tax exemption - [PUT /tax_exemptions/{tax_exemption_id}](https://docs.upvest.co/api/tax-exemptions/update_tax_exemption.md): Updates a tax exemption specified by its ID. ### Delete a tax exemption - [DELETE /tax_exemptions/{tax_exemption_id}](https://docs.upvest.co/api/tax-exemptions/delete_tax_exemption.md): Deletes a tax exemption specified by its ID. ### List tax exemptions for a user - [GET /users/{user_id}/tax_exemptions](https://docs.upvest.co/api/tax-exemptions/retrieve_tax_exemptions_for_user.md): Returns the tax exemptions of the user specified by ID. ### Tax Exemption Events - [POST Tax exemption events](https://docs.upvest.co/api/tax-exemptions/tax_exemption_event.md): Tax Exemption Events ### Tax Exemption Failure Events - [POST Tax exemption failure events](https://docs.upvest.co/api/tax-exemptions/tax_exemption_failure_event.md): Tax Exemption Failure Events ## Tax Collections All tax collections related paths ### Tax Collection Events - [POST Tax collection events](https://docs.upvest.co/api/tax-collections/tax_collection_event.md): Tax Collection Events ## Tax Wrappers All tax wrappers related paths ### Create a tax wrapper for ISA account - [POST /isa/wrappers](https://docs.upvest.co/api/tax-wrappers/create_isa_tax_wrapper.md): Creates a tax wrapper for ISA account. ### Retrieve ISA allowances - [GET /isa/wrappers/{tax_wrapper_id}/allowances](https://docs.upvest.co/api/tax-wrappers/retrieve_isa_allowances.md): Retrieves ISA allowances ### ISA Tax Wrappers events - [POST ISA tax wrapper events](https://docs.upvest.co/api/tax-wrappers/isa_tax_wrappers_event.md): ISA Tax Wrappers events ### ISA Allowance events - [POST ISA allowance events](https://docs.upvest.co/api/tax-wrappers/isa_allowance_event.md): ISA Allowance events ## Instruments All instrument related paths. ### List instruments - [GET /instruments](https://docs.upvest.co/api/instruments/list_instruments.md): List instruments ### Get instrument - [GET /instruments/{instrument_id}](https://docs.upvest.co/api/instruments/retrieve_instrument.md): Returns the instrument. ### Instruments events - [POST Instruments events](https://docs.upvest.co/api/instruments/instrument_event.md): Instruments events ## Price Data All price data related paths. ### Get instrument venues - [GET /instruments/{instrument_id}/venues](https://docs.upvest.co/api/price-data/retrieve_instrument_venues.md): The venues where the instrument is traded and for which the price data is available. ### Get instrument latest price - [GET /instruments/{instrument_id}/venues/{venue_id}/prices/latest](https://docs.upvest.co/api/price-data/retrieve_instrument_latest_price.md): Returns the instrument's latest price as available at the specified venue. NOTE: Please note that in live mode we provide the latest prices that we receive from our data provider. However, it is to be expected that such updates will only take place on trading days. ### Get instrument OHLC prices - [GET /instruments/{instrument_id}/venues/{venue_id}/prices/ohlc](https://docs.upvest.co/api/price-data/retrieve_instrument_prices_ohlc.md): Returns OHLC prices for the instrument at the specified venue for the chosen time period. If requested interval is 1d, then the response also includes days with 0 volume. In these cases open, high, low are empty (""), but close is provided. If requested interval is smaller than 1d, then the intervals with 0 volume are omitted from the response. NOTE: Please note that in live mode we provide the latest prices that we receive from our data provider. However, it is to be expected that such updates will only take place on trading days. ## Orders All order related paths. ### Get orders for an account by ID - [GET /accounts/{account_id}/orders](https://docs.upvest.co/api/orders/list_account_orders.md): Returns a list of all orders for the account specified by its ID. ### Place an order - [POST /orders](https://docs.upvest.co/api/orders/place_order.md): Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously. ### Get an order by ID - [GET /orders/{order_id}](https://docs.upvest.co/api/orders/retrieve_order.md): Returns the order specified by its ID. ### Cancel an order by ID - [DELETE /orders/{order_id}](https://docs.upvest.co/api/orders/cancel_order.md): Cancels an order specified by its ID. It is possible to cancel an order in the NEW or PROCESSING status. Once a cancellation has been accepted, the further processing steps take place asynchronously and depending on the respective order status. ### Get an order execution by ID - [GET /orders/{order_id}/executions/{execution_id}](https://docs.upvest.co/api/orders/retrieve_order_execution.md): Returns the order execution specified by its ID. ### Orders events - [POST Orders events](https://docs.upvest.co/api/orders/order_event.md): Orders events ### Executions events - [POST Executions events](https://docs.upvest.co/api/orders/execution_event.md): Executions events ### Order Cancellations events - [POST Order Cancellations events](https://docs.upvest.co/api/orders/order_cancellation_event.md): Order Cancellations events ## Portfolios All portfolios related paths. ### List portfolios allocations - [GET /portfolios/allocations](https://docs.upvest.co/api/portfolios/list_portfolios_allocations.md): List portfolios allocations ### Create portfolios allocation - [POST /portfolios/allocations](https://docs.upvest.co/api/portfolios/create_portfolios_allocation.md): Create portfolios allocation ### Retrieve portfolios allocation - [GET /portfolios/allocations/{allocation_id}](https://docs.upvest.co/api/portfolios/retrieve_portfolios_allocation.md): Retrieve portfolios allocation ### Update portfolios allocation - [PUT /portfolios/allocations/{allocation_id}](https://docs.upvest.co/api/portfolios/update_portfolios_allocation.md): Update portfolios allocation ### List portfolios configurations - [GET /portfolios/configurations](https://docs.upvest.co/api/portfolios/list_portfolios_configurations.md): List portfolios configurations ### Create portfolios configuration - [POST /portfolios/configurations](https://docs.upvest.co/api/portfolios/create_portfolios_configuration.md): Create portfolios configuration ### Retrieve portfolios configuration - [GET /portfolios/configurations/{account_id}](https://docs.upvest.co/api/portfolios/retrieve_portfolios_configuration.md): Retrieve portfolios configuration ### Update portfolios configuration - [PATCH /portfolios/configurations/{account_id}](https://docs.upvest.co/api/portfolios/update_portfolios_configuration.md): Update portfolios configuration ### List portfolios orders - [GET /portfolios/orders](https://docs.upvest.co/api/portfolios/list_portfolios_orders.md): List portfolios orders ### Create portfolios order - [POST /portfolios/orders](https://docs.upvest.co/api/portfolios/create_portfolios_order.md): Create portfolios order ### Retrieve portfolios order - [GET /portfolios/orders/{portfolio_order_id}](https://docs.upvest.co/api/portfolios/retrieve_portfolios_order.md): Retrieve portfolios order ### Cancel portfolios order - [DELETE /portfolios/orders/{portfolio_order_id}](https://docs.upvest.co/api/portfolios/cancel_portfolios_order.md): Cancel portfolios order. Cancellations may not be possible - in rare situations, some individual orders within portfolios order may already have been filled. In this case, cancellation could result in a mix of cancelled and filled orders. ### List portfolios allocation accounts - [GET /portfolios/allocations/{allocation_id}/accounts](https://docs.upvest.co/api/portfolios/list_portfolios_allocation_accounts.md): List portfolios allocation accounts ### Portfolios orders events - [POST Portfolio orders events](https://docs.upvest.co/api/portfolios/portfolio_order_event.md): Portfolios orders events ### Portfolios allocations events - [POST Portfolio allocations events](https://docs.upvest.co/api/portfolios/portfolio_allocation_event.md): Portfolios allocations events ## Portfolios Rebalancing All portfolios rebalancing related paths. ### Trigger portfolio rebalancing - [POST /portfolios/rebalancings/executions](https://docs.upvest.co/api/portfolios-rebalancing/trigger_portfolio_rebalancing.md): Trigger portfolio rebalancing ### Retrieve portfolios rebalancing execution - [GET /portfolios/rebalancings/executions/{execution_id}](https://docs.upvest.co/api/portfolios-rebalancing/retrieve_portfolios_rebalancing_execution.md): Retrieve portfolios rebalancing execution ### List portfolio rebalancing execution orders - [GET /portfolios/rebalancings/executions/{execution_id}/orders](https://docs.upvest.co/api/portfolios-rebalancing/list_portfolio_rebalancing_execution_orders.md): List portfolio rebalancing execution orders ### Portfolio rebalancing execution orders events - [POST Portfolio rebalancing execution orders events](https://docs.upvest.co/api/portfolios-rebalancing/portfolio_rebalancing_execution_order_event.md): Portfolio rebalancing execution orders events ## Savings Plans All savings plans related paths. ### Retrieve a savings plan - [GET /savings_plans/{savings_plan_id}](https://docs.upvest.co/api/savings-plans/retrieve_savings_plan.md): Retrieve a savings plan specified by its ID. ### Delete a savings plan - [DELETE /savings_plans/{savings_plan_id}](https://docs.upvest.co/api/savings-plans/delete_savings_plan.md): Delete a savings plan specified by its ID. ### List savings plans - [GET /savings_plans](https://docs.upvest.co/api/savings-plans/list_savings_plans.md): List savings plans ### Create savings plan - [POST /savings_plans](https://docs.upvest.co/api/savings-plans/create_savings_plan.md): Create savings plan ### Retrieve savings plan execution - [GET /savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}](https://docs.upvest.co/api/savings-plans/retrieve_savings_plan_execution.md): Retrieve savings plan execution ### Delete savings plan execution - [DELETE /savings_plans/{savings_plan_id}/executions/{savings_plan_execution_id}](https://docs.upvest.co/api/savings-plans/delete_savings_plan_execution.md): Delete savings plan execution ### List savings plan executions - [GET /savings_plans/{savings_plan_id}/executions](https://docs.upvest.co/api/savings-plans/list_savings_plan_executions.md): List savings plan executions for a saving plan specified by its ID. ### Savings plan execution events - [POST Savings plan execution events](https://docs.upvest.co/api/savings-plans/savings_plan_execution_event.md): Savings plan execution events ### Savings plan events - [POST Savings plan events](https://docs.upvest.co/api/savings-plans/savings_plan_event.md): Savings plan events ## Liquidations All accounts liquidations related paths. ### List accounts liquidations - [GET /accounts/{account_id}/liquidations](https://docs.upvest.co/api/liquidations/list_accounts_liquidations.md): List accounts liquidations ### Create account liquidation request - [POST /accounts/{account_id}/liquidations](https://docs.upvest.co/api/liquidations/create_account_liquidation.md): Create account liquidation request ### Retrieve account liquidation - [GET /accounts/{account_id}/liquidations/{account_liquidation_id}](https://docs.upvest.co/api/liquidations/retrieve_account_liquidation.md): Retrieve account liquidation ### Cancel account liquidation - [DELETE /accounts/{account_id}/liquidations/{account_liquidation_id}](https://docs.upvest.co/api/liquidations/cancel_account_liquidation.md): Cancel account liquidation ### Account liquidation events - [POST Account liquidation events](https://docs.upvest.co/api/liquidations/account_liquidation_event.md): Account liquidation events ## Direct Debits All direct debits related paths ### List direct debits - [GET /account_groups/{account_group_id}/payments/direct_debits](https://docs.upvest.co/api/direct-debits/list_direct_debits.md): List direct debits ### Trigger a direct debit - [POST /payments/direct_debits](https://docs.upvest.co/api/direct-debits/create_direct_debit.md): Trigger a direct debit ### Retrieve a direct debit - [GET /payments/direct_debits/{direct_debit_id}](https://docs.upvest.co/api/direct-debits/retrieve_direct_debit.md): Retrieve a direct debit ### Direct Debit events - [POST Direct Debit events](https://docs.upvest.co/api/direct-debits/direct_debit_event.md): Direct Debit events ## Top-ups All top-ups related paths ### List top-ups - [GET /account_groups/{account_group_id}/payments/topups](https://docs.upvest.co/api/top-ups/list_topups.md): Returns a list of top-ups. ### Trigger a top-up - [POST /payments/topups](https://docs.upvest.co/api/top-ups/create_topup.md): Triggers the creation of a top-up payment. ### Retrieve a top-up by ID - [GET /payments/topups/{topup_id}](https://docs.upvest.co/api/top-ups/retrieve_topup.md): Returns a top-up specified by its ID. ### Cancel a top-up by ID - [DELETE /payments/topups/{topup_id}](https://docs.upvest.co/api/top-ups/cancel_topup.md): Cancels a top-up specified by its ID. It is only possible to cancel a top-up if it has the status NEW or CONFIRMED. ### Top-up events - [POST Top-up events](https://docs.upvest.co/api/top-ups/topup_event.md): Top-up events ## Withdrawals All withdrawals related paths ### Trigger a withdrawal - [POST /payments/withdrawals](https://docs.upvest.co/api/withdrawals/create_cash_withdrawal.md): Trigger a withdrawal ### Retrieve withdrawal - [GET /payments/withdrawals/{withdrawal_id}](https://docs.upvest.co/api/withdrawals/retrieve_cash_withdrawal.md): Retrieve withdrawal ### Cancel withdrawal by ID - [DELETE /payments/withdrawals/{withdrawal_id}](https://docs.upvest.co/api/withdrawals/cancel_cash_withdrawal.md): Cancels a withdrawal specified by its ID. It is only possible to cancel a withdrawal if it has the status NEW. ### List withdrawals - [GET /account_groups/{account_group_id}/payments/withdrawals](https://docs.upvest.co/api/withdrawals/list_cash_withdrawals.md): List withdrawals ### Withdrawals events - [POST Withdrawals events](https://docs.upvest.co/api/withdrawals/withdrawal_event.md): Withdrawals events ## Reference Accounts All reference account related paths ### Get reference accounts of a user - [GET /users/{user_id}/payments/reference_accounts](https://docs.upvest.co/api/reference-accounts/list_reference_accounts.md): Returns the list of reference accounts of a user specified by ID. ### Create a reference account - [POST /payments/reference_accounts](https://docs.upvest.co/api/reference-accounts/create_reference_account.md): Creates a new reference account for a user specified by ID. ### Get a reference account by ID - [GET /payments/reference_accounts/{reference_account_id}](https://docs.upvest.co/api/reference-accounts/retrieve_reference_account.md): Retrieves the reference account specified by its ID. ### Delete a reference account by ID - [DELETE /payments/reference_accounts/{reference_account_id}](https://docs.upvest.co/api/reference-accounts/delete_reference_account.md): Deletes the reference account specified by its ID. ## Mandates All direct debit mandates related paths ### List mandates - [GET /users/{user_id}/payments/mandates](https://docs.upvest.co/api/mandates/list_mandates.md): List mandates ### Create a mandate - [POST /payments/mandates](https://docs.upvest.co/api/mandates/create_mandate.md): Create a mandate ### Retrieve a direct debit mandate - [GET /payments/mandates/{mandate_id}](https://docs.upvest.co/api/mandates/retrieve_mandate.md): Retrieve a direct debit mandate ### Delete mandate - [DELETE /payments/mandates/{mandate_id}](https://docs.upvest.co/api/mandates/delete_mandate.md): Delete mandate ## Cash Balances All cash balance related paths ### Retrieve an account group's cash balance for particular ISO currency code - [GET /account_groups/{account_group_id}/payments/cash_balances/{currency}](https://docs.upvest.co/api/cash-balances/retrieve_cash_balance_with_currency.md): Retrieve an account group's cash balance for particular ISO currency code ### Retrieve an account group's cash balance (deprecated) - [GET /account_groups/{account_group_id}/payments/cash_balance](https://docs.upvest.co/api/cash-balances/retrieve_cash_balance.md): Retrieve an account group's cash balance ### Retrieve an account group's cash balances (deprecated) - [GET /account_groups/{account_group_id}/payments/cash_balances](https://docs.upvest.co/api/cash-balances/retrieve_cash_balances.md): Retrieve an account group's cash balances ### Cash Balance events - [POST Cash Balance events](https://docs.upvest.co/api/cash-balances/cash_balance_event.md): Cash Balance events ## Positions All positions related paths. ### List positions - [GET /accounts/{account_id}/positions](https://docs.upvest.co/api/positions/list_positions.md): List of account positions ### Retrieve position - [GET /accounts/{account_id}/positions/{instrument_id}](https://docs.upvest.co/api/positions/retrieve_position.md): Retrieve an account position ### Positions events - [POST Positions events](https://docs.upvest.co/api/positions/position_event.md): Positions events ## Valuations All valuations related paths. ### Get current valuation for an account - [GET /accounts/{account_id}/valuations/current](https://docs.upvest.co/api/valuations/get_account_valuation.md): Get current valuation for an account ### List valuation history for an account - [GET /accounts/{account_id}/valuations](https://docs.upvest.co/api/valuations/list_account_valuation_history.md): List valuation history for an account ### Account valuation events - [POST Account valuation events](https://docs.upvest.co/api/valuations/account_valuation_event.md): Account valuation events ### Intraday account valuation events - [POST Intraday account valuation events](https://docs.upvest.co/api/valuations/intraday_account_valuation_event.md): Intraday account valuation events ## Returns All accounts returns related paths. ### List account returns - [GET /accounts/{account_id}/returns](https://docs.upvest.co/api/returns/list_account_returns.md): List account returns ### Account returns event - [POST Account returns events](https://docs.upvest.co/api/returns/account_returns_event.md): Account returns event ## Virtual Cash Balances All virtual cash balances related paths ### Trigger a virtual cash increase - [POST /virtual_cash_balances/increases](https://docs.upvest.co/api/virtual-cash-balances/create_virtual_cash_increase.md): Trigger a virtual cash increase ### Trigger a virtual cash decrease - [POST /virtual_cash_balances/decreases](https://docs.upvest.co/api/virtual-cash-balances/create_virtual_cash_decrease.md): Trigger a virtual cash decrease ### Cancel virtual cash decrease by ID - [DELETE /virtual_cash_balances/decreases/{virtual_cash_decrease_id}](https://docs.upvest.co/api/virtual-cash-balances/cancel_virtual_cash_decrease.md): Cancels a virtual cash decrease specified by its ID. It is only possible to cancel a virtual cash decrease if it has the status ISSUED or QUEUED. ### Virtual cash increase events - [POST Virtual cash increase events](https://docs.upvest.co/api/virtual-cash-balances/virtual_cash_increase_event.md): Virtual cash increase events ### Virtual cash decrease events - [POST Virtual cash decrease events](https://docs.upvest.co/api/virtual-cash-balances/virtual_cash_decrease_event.md): Virtual cash decrease events ## Fees All fees related paths. ### Get fee collections - [GET /fees/collections](https://docs.upvest.co/api/fees/list_fee_collections.md): Returns a list of fee collections. ### Create a fee collection - [POST /fees/collections](https://docs.upvest.co/api/fees/create_fee_collection.md): Creates a fee collection for pre-calculated fee amounts. ### Get a fee collection by ID - [GET /fees/collections/{fee_collection_id}](https://docs.upvest.co/api/fees/retrieve_fee_collection.md): Returns the fee collection specified by its ID. ### Fee collection events - [POST Fee collection events](https://docs.upvest.co/api/fees/fee_collection_event.md): Fee collection events ## Fees Configurations All fees configurations related paths. ### Create a fee configuration - [POST /fees/configurations](https://docs.upvest.co/api/fees-configurations/create_fee_configuration.md): Creates a fee configuration for a fee collection. ### Get fee configuration - [GET /fees/configurations/{account_id}](https://docs.upvest.co/api/fees-configurations/retrieve_fee_configurations.md): Retrieve the fee configuration for a specific account. ### Update fee configuration - [PATCH /fees/configurations/{account_id}](https://docs.upvest.co/api/fees-configurations/update_fee_configuration.md): Update fee configuration ## Reports All reports related paths. ### List user reports - [GET /users/{user_id}/reports](https://docs.upvest.co/api/reports/list_reports.md): List user reports ### Create a user report - [POST /reports](https://docs.upvest.co/api/reports/create_report.md): Create a user report ### Retrieve a user report - [GET /reports/{report_id}](https://docs.upvest.co/api/reports/retrieve_report.md): Retrieve a user report ### User reports events - [POST User reports events](https://docs.upvest.co/api/reports/report_event.md): User reports events ## Treasury Reports All treasury reports related paths. ### Treasury reports events - [POST Treasury reports events](https://docs.upvest.co/api/treasury-reports/treasury_report_event.md): Treasury reports events ## Transactions All transactions related paths. ### List cash transactions - [GET /transactions/cash](https://docs.upvest.co/api/transactions/list_cash_transactions.md): List cash transactions ### List securities transactions - [GET /transactions/securities](https://docs.upvest.co/api/transactions/list_securities_transactions.md): List securities transactions ### Cash transactions events - [POST Cash transactions events](https://docs.upvest.co/api/transactions/cash_transaction_event.md): Cash transactions events ### Security transactions events - [POST Security transactions events](https://docs.upvest.co/api/transactions/security_transaction_event.md): Security transactions events ## Files All files API related paths. ### Retrieve a file metadata - [GET /files/{folder}/{file_name}](https://docs.upvest.co/api/files/fetching_file_metadata.md): Retrieve a file metadata ## Webhook Subscriptions All webhook subscriptions related paths. ### Get signing keys - [GET /auth/verify_keys](https://docs.upvest.co/api/webhook-subscriptions/get_jwks.md): Returns a list of signing keys used to verify webhooks. ### List all webhook subscriptions - [GET /webhooks](https://docs.upvest.co/api/webhook-subscriptions/list_webhooks.md): Returns a list of all webhook subscriptions. ### Create a webhook subscription - [POST /webhooks](https://docs.upvest.co/api/webhook-subscriptions/create_webhook.md): Creates a webhook subscription. ### Retrieve a webhook subscription - [GET /webhooks/{webhook_id}](https://docs.upvest.co/api/webhook-subscriptions/retrieve_webhook.md): Returns a webhook subscription specified by its ID. ### Delete a webhook subscription - [DELETE /webhooks/{webhook_id}](https://docs.upvest.co/api/webhook-subscriptions/delete_webhook.md): Deletes a webhook subscription specified by its ID. ### Update a webhook subscription - [PATCH /webhooks/{webhook_id}](https://docs.upvest.co/api/webhook-subscriptions/update_webhook.md): Updates a webhook subscription specified by its ID. ### Test a webhook subscription - [POST /webhooks/{webhook_id}/test](https://docs.upvest.co/api/webhook-subscriptions/test_webhook.md): Tests a webhook subscription specified by its ID. ## Virtual Bank Accounts All virtual bank accounts related paths ### List virtual bank accounts - [GET /account_groups/{account_group_id}/payments/virtual_bank_accounts](https://docs.upvest.co/api/virtual-bank-accounts/list_virtual_bank_accounts.md): Returns a list of virtual bank accounts. ### Create a virtual bank account - [POST /payments/virtual_bank_accounts](https://docs.upvest.co/api/virtual-bank-accounts/create_virtual_bank_account.md): Triggers the creation of a virtual bank account. ### Retrieve a virtual bank account by ID - [GET /payments/virtual_bank_accounts/{virtual_bank_account_id}](https://docs.upvest.co/api/virtual-bank-accounts/retrieve_virtual_bank_account.md): Returns a virtual bank account specified by its ID. ### Virtual Bank Accounts events - [POST Virtual Bank Accounts events](https://docs.upvest.co/api/virtual-bank-accounts/virtual_bank_account_event.md): Virtual Bank Accounts events ## Tests All test related paths. ### Trigger a bank transaction - [POST /tests/payments/transactions](https://docs.upvest.co/api/tests/create_bank_transaction.md): Trigger a bank transaction for testing purposes. This can be used to simulate a money transfer for various flows which need cash settlements on one of our bank accounts.