# List securities transactions

Returns the list of securities transactions for an account group or a single account.
Securities movements are recorded at account level, so this endpoint accepts both `account_group_id` and `account_id`. Restrict the period with the `start_date` and `end_date` query parameters, and page through results with `offset` and `limit`; `meta.total_count` gives the total number of matching transactions.
See the transactions reports guide ([TOL](https://docs.upvest.co/products/tol/guides/reports/account_reports_transactions) / [BYOL](https://docs.upvest.co/products/byol/guides/reports/account_reports_transactions) / [Omnibus](https://docs.upvest.co/products/omnibus/guides/reports/account_reports_transactions)) for the full list of transaction types.

Endpoint: GET /transactions/securities
Version: 1.159.0
Security: oauth-client-credentials

## Security:

  - `oauth-client-credentials` (unknown)
    oauth2 scopes: transactions:read

## Query parameters:

  - `account_group_id` (string)
    Filters the list to only show transactions associated with a certain account group ID.

  - `account_id` (string)
    Filters the list to only show transactions associated with a certain account ID.

  - `start_date` (string)

  - `end_date` (string)

  - `sort` (string)
    Sort the result by `booking_date`.

  - `order` (string)
    Sort order of the result list if the `sort` parameter is specified. Use `ASC` for ascending or `DESC` for descending sort order.

  - `offset` (integer)
    Use the `offset` argument to specify where in the list of results to start when returning items for a particular query.

  - `limit` (integer)
    Use the `limit` argument to specify the maximum number of items returned.

## Header parameters:

  - `upvest-client-id` (string, required)
    Your client ID, issued by Upvest. Identifies the client making the request. Universally Unique Identifier (UUID).

  - `Authorization` (string, required)
    Bearer (access) token from the OAuth flow with correct scopes.
https://datatracker.ietf.org/doc/html/rfc6750

  - `signature` (string, required)
    https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

  - `signature-input` (string, required)
    https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

  - `upvest-api-version` (string)
    Upvest API version (Note: Do not include quotation marks)

## Response 200:

  - `200` (unknown)
    Securities Transactions

## Response 200 fields (application/json):

  - `meta` (object, required)
    Offset/limit pagination metadata for a list response. Contains the `offset` and `limit` applied to the request, the `count` of resources returned in this page, and the `total_count` of matching resources.

  - `meta.offset` (integer, required)
    Amount of resource to offset in the response.

  - `meta.limit` (integer, required)
    Total limit of the response.

  - `meta.count` (integer, required)
    Count of the resources returned in the response.

  - `meta.total_count` (integer, required)
    Total count of all the resources.

  - `meta.sort` (string)
    The field that the list is sorted by.

  - `meta.order` (string)
    The ordering applied to the list.
* ASC — Ascending order.
* DESC — Descending order.
    Enum: "ASC", "DESC"

  - `data` (array, required)
    The securities transactions in this page of results.

  - `data.account_group_id` (string, required)
    Universally Unique Identifier (UUID) of the account group.

  - `data.account_id` (string, required)
    Universally Unique Identifier (UUID) of the account.

  - `data.booking_date` (string, required)
    Transaction booking date and time. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `data.created_at` (string, required)
    Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `data.delta` (object, required)
    Entity representing the security transaction delta.

  - `data.delta.amount` (string, required)

  - `data.id` (string, required)
    Security transaction unique identifier.

  - `data.instrument` (object, required)
    Entity representing instrument.

  - `data.instrument.uuid` (string, required)
    Internal instrument identifier.

  - `data.instrument.isin` (string)
    International securities identification number defined by [ISO 6166](https://en.wikipedia.org/wiki/International_Securities_Identification_Number).

  - `data.type` (string, required)
    Transaction type
* ACCUMULATION - Accumulation
* ACCUMULATION_CANCELLATION - Accumulation cancellation
* ANNUAL_GENERAL_MEETING - Annual general meeting
* ANNUAL_GENERAL_MEETING_CANCELLATION - Annual general meeting cancellation
* ATTACHMENT - Attachment
* ATTACHMENT_CANCELLATION - Attachment cancellation
* BALANCE_CORRECTION - Balance correction
* BALANCE_CORRECTION_CANCELLATION - Balance correction cancellation
* BANKRUPTCY - Bankruptcy
* BANKRUPTCY_CANCELLATION - Bankruptcy cancellation
* BOND_DEFAULT - Bond default
* BOND_DEFAULT_CANCELLATION - Bond default cancellation
* BOND_HOLDER_MEETING - Bond holder meeting
* BOND_HOLDER_MEETING_CANCELLATION - Bond holder meeting cancellation
* BONUS_ISSUE - Bonus Issue/Capitalisation Issue
* BONUS_ISSUE_CANCELLATION - Bonus Issue/Capitalisation Issue, Cancellation
* CALL_ON_INTERMEDIATE_SECURITIES - Call on Intermediate Securities
* CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION - Call on Intermediate Securities, Cancellation
* CAPITAL_DISTRIBUTION - Capital distribution
* CAPITAL_DISTRIBUTION_CANCELLATION - Capital distribution cancellation
* CAPITAL_GAINS_DISTRIBUTION - Capital gains distribution
* CAPITAL_GAINS_DISTRIBUTION_CANCELLATION - Capital gains distribution cancellation
* CAPITALISATION - Capitalisation
* CAPITALISATION_CANCELLATION - Capitalisation cancellation
* CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES - Cash distribution from non eligible securities sales
* CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION - Cash distribution from non eligible securities sales cancellation
* CASH_DIVIDEND - Cash dividend
* CASH_DIVIDEND_CANCELLATION - Cash dividend cancellation
* CHANGE - Change
* CHANGE_CANCELLATION - Change, Cancellation
* CLASS_ACTION - Class action
* CLASS_ACTION_CANCELLATION - Class action cancellation
* COMPANY_OPTION - Company option
* COMPANY_OPTION_CANCELLATION - Company option cancellation
* CONSENT - Consent
* CONSENT_CANCELLATION - Consent cancellation
* CONVERSION - Conversion
* CONVERSION_CANCELLATION - Conversion cancellation
* COURT_MEETING - Court meeting
* COURT_MEETING_CANCELLATION - Court meeting cancellation
* CREDIT_EVENT - Credit event
* CREDIT_EVENT_CANCELLATION - Credit event cancellation
* DECREASE_IN_VALUE - Decrease in value
* DECREASE_IN_VALUE_CANCELLATION - Decrease in value cancellation
* DETACHMENT - Detachment
* DETACHMENT_CANCELLATION - Detachment cancellation
* DISCLOSURE - Disclosure
* DISCLOSURE_CANCELLATION - Disclosure cancellation
* DIVIDEND_OPTION - Dividend Option
* DIVIDEND_OPTION_CANCELLATION - Dividend Option, Cancellation
* DIVIDEND_REINVESTMENT - Dividend Reinvestment
* DIVIDEND_REINVESTMENT_CANCELLATION - Dividend Reinvestment, Cancellation
* DRAWING - Drawing
* DRAWING_CANCELLATION - Drawing cancellation
* DUST_CLEANUP - Dust Cleanup
* DUTCH_AUCTION - Dutch Auction
* DUTCH_AUCTION_CANCELLATION - Dutch Auction, Cancellation
* EXCHANGE - Exchange
* EXCHANGE_CANCELLATION - Exchange cancellation
* EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING - Extraordinary or special general meeting
* EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION - Extraordinary or special general meeting cancellation
* FINAL_MATURITY - Final maturity
* FINAL_MATURITY_CANCELLATION - Final maturity cancellation
* FULL_CALL - Full call
* FULL_CALL_CANCELLATION - Full call cancellation
* INCREASE_IN_VALUE - Increase in value
* INCREASE_IN_VALUE_CANCELLATION - Increase in value cancellation
* INFORMATION - Information
* INFORMATION_CANCELLATION - Information cancellation
* INSTALMENT_CALL - Instalment call
* INSTALMENT_CALL_CANCELLATION - Instalment call cancellation
* INTEREST_PAYMENT - Interest payment
* INTEREST_PAYMENT_CANCELLATION - Interest payment cancellation
* INTERMEDIATE_SECURITIES_DISTRIBUTION - Intermediate Securities Distribution
* INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION - Intermediate Securities Distribution, Cancellation
* LIQUIDATION_PAYMENT - Liquidation Dividend/Liquidation Payment
* LIQUIDATION_PAYMENT_CANCELLATION - Liquidation Dividend/Liquidation Payment, Cancellation
* MATURITY_EXTENSION - Maturity extension
* MATURITY_EXTENSION_CANCELLATION - Maturity extension cancellation
* MERGER - Merger
* MERGER_CANCELLATION - Merger, Cancellation
* NON_OFFICIAL_OFFER - Non-Official Offer
* NON_OFFICIAL_OFFER_CANCELLATION - Non-Official Offer, Cancellation
* NON_US_TEFRA_D_CERTIFICATION - Non us tefra d certification
* NON_US_TEFRA_D_CERTIFICATION_CANCELLATION - Non us tefra d certification cancellation
* ODD_LOT_SALE - Odd Lot Sale/Purchase
* ODD_LOT_SALE_CANCELLATION - Odd Lot Sale/Purchase, Cancellation
* ORDER_EXECUTION - Order execution
* ORDER_EXECUTION_CANCELLATION - Order execution cancellation
* ORDINARY_GENERAL_MEETING - Ordinary general meeting
* ORDINARY_GENERAL_MEETING_CANCELLATION - Ordinary general meeting cancellation
* OTHER_EVENT - Other Event
* OTHER_EVENT_CANCELLATION - Other Event cancellation
* PARI_PASSU - Pari passu
* PARI_PASSU_CANCELLATION - Pari passu cancellation
* PARTIAL_DEFEASANCE - Partial defeasance
* PARTIAL_DEFEASANCE_CANCELLATION - Partial defeasance cancellation
* PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION - Partial redemption with pool factor reduction
* PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption with pool factor reduction cancellation
* PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION - Partial redemption without pool factor reduction
* PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION - Partial redemption without pool factor reduction cancellation
* PAY_IN_KIND - Pay in kind
* PAY_IN_KIND_CANCELLATION - Pay in kind cancellation
* PEAK_FRACTION_COMPENSATION - Peak fraction compensation
* PEAK_ORDER_ADJUSTMENT - Peak order adjustment
* PLACE_OF_INCORPORATION - Place of incorporation
* PLACE_OF_INCORPORATION_CANCELLATION - Place of incorporation cancellation
* PRIORITY_ISSUE - Priority Issue
* PRIORITY_ISSUE_CANCELLATION - Priority Issue, Cancellation
* PUT_REDEMPTION - Put redemption
* PUT_REDEMPTION_CANCELLATION - Put redemption cancellation
* REDENOMINATION - Redenomination
* REDENOMINATION_CANCELLATION - Redenomination cancellation
* REMARKETING_AGREEMENT - Remarketing agreement
* REMARKETING_AGREEMENT_CANCELLATION - Remarketing agreement cancellation
* REPURCHASE_OFFER - Repurchase Offer/Issuer Bid/Reverse Rights
* REPURCHASE_OFFER_CANCELLATION - Repurchase Offer/Issuer Bid/Reverse Rights, Cancellation
* REVERSE_STOCK_SPLIT - Reverse Stock Split/Change in Nominal Value
* REVERSE_STOCK_SPLIT_CANCELLATION - Reverse Stock Split/Change in Nominal Value, Cancellation
* RIGHTS_ISSUE - Rights Issue/Subscription Rights/Rights Offer
* RIGHTS_ISSUE_CANCELLATION - Rights Issue/Subscription Rights/Rights Offer, Cancellation
* SCRIP_DIVIDEND - Scrip dividend
* SCRIP_DIVIDEND_CANCELLATION - Scrip dividend cancellation
* SECURITIES_TRANSFER - Securities transfer
* SECURITIES_TRANSFER_CANCELLATION - Securities transfer cancellation
* SHARES_PREMIUM_DIVIDEND - Shares premium dividend
* SHARES_PREMIUM_DIVIDEND_CANCELLATION - Shares premium dividend cancellation
* SMALLEST_NEGOTIABLE_UNIT - Smallest negotiable unit
* SMALLEST_NEGOTIABLE_UNIT_CANCELLATION - Smallest negotiable unit cancellation
* SPIN_OFF - Spin-Off
* SPIN_OFF_CANCELLATION - Spin-Off, Cancellation
* STOCK_DIVIDEND - Stock Dividend
* STOCK_DIVIDEND_CANCELLATION - Stock Dividend, Cancellation
* STOCK_SPLIT - Stock Split/Change in Nominal Value/Subdivision
* STOCK_SPLIT_CANCELLATION - Stock Split/Change in Nominal Value/Subdivision, Cancellation
* TAX_ON_NON_DISTRIBUTED_PROCEEDS - Tax on non distributed proceeds
* TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION - Tax on non distributed proceeds cancellation
* TAX_RECLAIM - Tax reclaim
* TAX_RECLAIM_CANCELLATION - Tax reclaim cancellation
* TENDER - Tender/Acquisition/Takeover/Purchase Offer
* TENDER_CANCELLATION - Tender/Acquisition/Takeover/Purchase Offer, Cancellation
* TRADING_STATUS_ACTIVE - Trading status active
* TRADING_STATUS_ACTIVE_CANCELLATION - Trading status active cancellation
* TRADING_STATUS_DELISTED - Trading status delisted
* TRADING_STATUS_DELISTED_CANCELLATION - Trading status delisted cancellation
* TRADING_STATUS_SUSPENDED - Trading status suspended
* TRADING_STATUS_SUSPENDED_CANCELLATION - Trading status suspended cancellation
* VIRTUAL_CASH_CORRECTION_CANCELLATION - Virtual cash correction cancellation
* WARRANT_EXERCISE - Warrant exercise
* WARRANT_EXERCISE_CANCELLATION - Warrant exercise cancellation
* WITHHOLDING_TAX_RELIEF_CERTIFICATION - Withholding tax relief certification
* WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION - Withholding tax relief certification cancellation
* WORTHLESS - Worthless
* WORTHLESS_CANCELLATION - Worthless, Cancellation
* SECURITIES_LENDING - Securities lending
    Enum: "ACCUMULATION", "ACCUMULATION_CANCELLATION", "ANNUAL_GENERAL_MEETING", "ANNUAL_GENERAL_MEETING_CANCELLATION", "ATTACHMENT", "ATTACHMENT_CANCELLATION", "BALANCE_CORRECTION", "BALANCE_CORRECTION_CANCELLATION", "BANKRUPTCY", "BANKRUPTCY_CANCELLATION", "BOND_DEFAULT", "BOND_DEFAULT_CANCELLATION", "BOND_HOLDER_MEETING", "BOND_HOLDER_MEETING_CANCELLATION", "BONUS_ISSUE", "BONUS_ISSUE_CANCELLATION", "CALL_ON_INTERMEDIATE_SECURITIES", "CALL_ON_INTERMEDIATE_SECURITIES_CANCELLATION", "CAPITAL_DISTRIBUTION", "CAPITAL_DISTRIBUTION_CANCELLATION", "CAPITAL_GAINS_DISTRIBUTION", "CAPITAL_GAINS_DISTRIBUTION_CANCELLATION", "CAPITALISATION", "CAPITALISATION_CANCELLATION", "CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES", "CASH_DISTRIBUTION_FROM_NON_ELIGIBLE_SECURITIES_SALES_CANCELLATION", "CASH_DIVIDEND", "CASH_DIVIDEND_CANCELLATION", "CHANGE", "CHANGE_CANCELLATION", "CLASS_ACTION", "CLASS_ACTION_CANCELLATION", "COMPANY_OPTION", "COMPANY_OPTION_CANCELLATION", "CONSENT", "CONSENT_CANCELLATION", "CONVERSION", "CONVERSION_CANCELLATION", "COURT_MEETING", "COURT_MEETING_CANCELLATION", "CREDIT_EVENT", "CREDIT_EVENT_CANCELLATION", "DECREASE_IN_VALUE", "DECREASE_IN_VALUE_CANCELLATION", "DETACHMENT", "DETACHMENT_CANCELLATION", "DISCLOSURE", "DISCLOSURE_CANCELLATION", "DIVIDEND_OPTION", "DIVIDEND_OPTION_CANCELLATION", "DIVIDEND_REINVESTMENT", "DIVIDEND_REINVESTMENT_CANCELLATION", "DRAWING", "DRAWING_CANCELLATION", "DUST_CLEANUP", "DUTCH_AUCTION", "DUTCH_AUCTION_CANCELLATION", "EXCHANGE", "EXCHANGE_CANCELLATION", "EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING", "EXTRAORDINARY_OR_SPECIAL_GENERAL_MEETING_CANCELLATION", "FINAL_MATURITY", "FINAL_MATURITY_CANCELLATION", "FULL_CALL", "FULL_CALL_CANCELLATION", "INCREASE_IN_VALUE", "INCREASE_IN_VALUE_CANCELLATION", "INFORMATION", "INFORMATION_CANCELLATION", "INSTALMENT_CALL", "INSTALMENT_CALL_CANCELLATION", "INTEREST_PAYMENT", "INTEREST_PAYMENT_CANCELLATION", "INTERMEDIATE_SECURITIES_DISTRIBUTION", "INTERMEDIATE_SECURITIES_DISTRIBUTION_CANCELLATION", "LIQUIDATION_PAYMENT", "LIQUIDATION_PAYMENT_CANCELLATION", "MATURITY_EXTENSION", "MATURITY_EXTENSION_CANCELLATION", "MERGER", "MERGER_CANCELLATION", "NON_OFFICIAL_OFFER", "NON_OFFICIAL_OFFER_CANCELLATION", "NON_US_TEFRA_D_CERTIFICATION", "NON_US_TEFRA_D_CERTIFICATION_CANCELLATION", "ODD_LOT_SALE", "ODD_LOT_SALE_CANCELLATION", "ORDER_EXECUTION", "ORDER_EXECUTION_CANCELLATION", "ORDINARY_GENERAL_MEETING", "ORDINARY_GENERAL_MEETING_CANCELLATION", "OTHER_EVENT", "OTHER_EVENT_CANCELLATION", "PARI_PASSU", "PARI_PASSU_CANCELLATION", "PARTIAL_DEFEASANCE", "PARTIAL_DEFEASANCE_CANCELLATION", "PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION", "PARTIAL_REDEMPTION_WITH_POOL_FACTOR_REDUCTION_CANCELLATION", "PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION", "PARTIAL_REDEMPTION_WITHOUT_POOL_FACTOR_REDUCTION_CANCELLATION", "PAY_IN_KIND", "PAY_IN_KIND_CANCELLATION", "PEAK_FRACTION_COMPENSATION", "PEAK_ORDER_ADJUSTMENT", "PLACE_OF_INCORPORATION", "PLACE_OF_INCORPORATION_CANCELLATION", "PRIORITY_ISSUE", "PRIORITY_ISSUE_CANCELLATION", "PUT_REDEMPTION", "PUT_REDEMPTION_CANCELLATION", "REDENOMINATION", "REDENOMINATION_CANCELLATION", "REMARKETING_AGREEMENT", "REMARKETING_AGREEMENT_CANCELLATION", "REPURCHASE_OFFER", "REPURCHASE_OFFER_CANCELLATION", "REVERSE_STOCK_SPLIT", "REVERSE_STOCK_SPLIT_CANCELLATION", "RIGHTS_ISSUE", "RIGHTS_ISSUE_CANCELLATION", "SCRIP_DIVIDEND", "SCRIP_DIVIDEND_CANCELLATION", "SECURITIES_TRANSFER", "SECURITIES_TRANSFER_CANCELLATION", "SHARES_PREMIUM_DIVIDEND", "SHARES_PREMIUM_DIVIDEND_CANCELLATION", "SMALLEST_NEGOTIABLE_UNIT", "SMALLEST_NEGOTIABLE_UNIT_CANCELLATION", "SPIN_OFF", "SPIN_OFF_CANCELLATION", "STOCK_DIVIDEND", "STOCK_DIVIDEND_CANCELLATION", "STOCK_SPLIT", "STOCK_SPLIT_CANCELLATION", "TAX_ON_NON_DISTRIBUTED_PROCEEDS", "TAX_ON_NON_DISTRIBUTED_PROCEEDS_CANCELLATION", "TAX_RECLAIM", "TAX_RECLAIM_CANCELLATION", "TENDER", "TENDER_CANCELLATION", "TRADING_STATUS_ACTIVE", "TRADING_STATUS_ACTIVE_CANCELLATION", "TRADING_STATUS_DELISTED", "TRADING_STATUS_DELISTED_CANCELLATION", "TRADING_STATUS_SUSPENDED", "TRADING_STATUS_SUSPENDED_CANCELLATION", "VIRTUAL_CASH_CORRECTION_CANCELLATION", "WARRANT_EXERCISE", "WARRANT_EXERCISE_CANCELLATION", "WITHHOLDING_TAX_RELIEF_CERTIFICATION", "WITHHOLDING_TAX_RELIEF_CERTIFICATION_CANCELLATION", "WORTHLESS", "WORTHLESS_CANCELLATION", "SECURITIES_LENDING"

  - `data.references` (array, required)
    Identifiers of the resources that this transaction relates to, such as the order or corporate action that caused it.

  - `data.references.id` (string, required)
    Unique identifier for a resource of given type.

  - `data.references.type` (string, required)
    The kind of resource that this reference points to.
* ORDER — Order.
* ORDER_EXECUTION — Order execution.
* CORPORATE_ACTION — Corporate action.
* CORPORATE_ACTION_TRANSACTION_ID — Corporate action transaction ID.
    Enum: "ORDER", "ORDER_EXECUTION", "CORPORATE_ACTION", "CORPORATE_ACTION_TRANSACTION_ID"

  - `data.updated_at` (string, required)
    Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `data.value_date` (string, required)
    Transaction value date and time. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

## Response 200 headers (application/json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 400:

  - `400` (unknown)
    Bad Request. The incoming request had a malformed parameter/object.

## Response 400 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 400 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 401:

  - `401` (unknown)
    Unauthorized. The caller has not been authenticated.

## Response 401 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 401 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 403:

  - `403` (unknown)
    Forbidden. The caller has been authenticated but is not allowed to take the requested action.

## Response 403 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 403 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 404:

  - `404` (unknown)
    Not Found. The requested resource could not be found.

## Response 404 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 404 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 405:

  - `405` (unknown)
    Method Not Allowed. The requested method is not allowed on the requested resource.

## Response 405 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 405 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 406:

  - `406` (unknown)
    Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

## Response 406 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 406 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 429:

  - `429` (unknown)
    Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

## Response 429 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 429 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 500:

  - `500` (unknown)
    Internal Server Error. The service encountered an unexpected error.

## Response 500 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 500 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 503:

  - `503` (unknown)
    Service Unavailable. The service handling for this request cannot be reached at this time.

## Response 503 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 503 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7

## Response 504:

  - `504` (unknown)
    Gateway Timeout. The service gateway has reached its internal timeout.

## Response 504 fields (application/problem+json):

  - `type` (string, required)
    URL to a document describing the error condition.

  - `status` (integer, required)
    Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

  - `title` (string)
    A short, human-readable title for the general error type; the title should not change for given types.

  - `detail` (string)
    A human-readable description of the specific error.

  - `instance` (string)
    This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

  - `request_id` (string)
    Correlation ID for the original request.

## Response 504 headers (application/problem+json):

  - `upvest-request-id` (string, required)
    Example: 169ae4c7-ebd7-4041-94da-25369653eba7