Reports

Download Spec

All reports related paths.

List user reports

get /users/{user_id}/reports

List user reports

OAuth2 oauth-client-credentials

Required Scopes:

reports:readreports:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

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)

Default
"1"
Enum
  • 1
Example
1

user_id

string

uuid

required

User unique identifier.

type

string

Filters the list to only show reports of a certain type (e.g. only buy order confirmations)

Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED
  • AD_HOC_ACCOUNT_STATEMENT
  • ORDER_EX_ANTE_COST
  • EX_POST_COST
  • TAX_OPTIMISATION
Example
"BUY_ORDER"

instrument

One Of

Filters the list to only include reports concerning specified instrument

Example
"uuid:ebabcf4d-61c3-4942-875c-e265a7c2d062"

International securities identification number, prefixed with string 'isin:'

string

^isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number, prefixed with string 'isin:'

Unique identifier, prefixed with string 'uuid:'

string

^uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Unique identifier, prefixed with string 'uuid:'

start_date

string

date

Returns reports generated starting from and including this date (UTC)

Example
"2020-08-21"

end_date

string

date

Returns reports generated up until this date (UTC)

Example
"2020-09-25"

sort

string

Field of resource to sort by

Default
"created_at"
Enum
  • id
  • type
  • created_at
Example
"id"

order

string

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

offset

int

i32

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

Min
0

Response

Examples Schema

Reports list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
      "created_at": "2020-08-24T14:15:22Z",
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
      "type": "BUY_ORDER",
      "substituted_report_id": null,
      "data": {
        "account": {
          "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
        }
      }
    }
  ]
}

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

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

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

required

The field that the list is sorted by.

order

string

required

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[One Of]

required

Report

One Of

Report

object (Report)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

Report type

  • BUY_ORDER - Buy order
  • SELL_ORDER - Sell order
  • INCOME_DISTRIBUTION - Income distribution report
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • FUND_COMMUNICATION - Generic fund communication
  • TAX_REFUND - Tax refund document (after tax optimization)
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • ACCOUNT_OPENING - Securities account opening
  • ACCOUNT_CLOSING - Securities account closure
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • GENERIC_COMMUNICATION - Generic communication
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • EX_POST_COST - Ex-post cost report
  • TAX_OPTIMISATION - Tax optimisation report
Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED
  • AD_HOC_ACCOUNT_STATEMENT
  • EX_POST_COST
  • TAX_OPTIMISATION

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the report.

account

object (account)

Account information.

id

string

uuid

Account unique identifier.

Report - Order ex-ante cost

object (Report - Order ex-ante cost)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

The type of report must be “ORDER_EX_ANTE_COST”.

Default
"ORDER_EX_ANTE_COST"

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the order ex-ante cost report.

holding_period

object (holding_period)

Holding period.

unit

string

Unit of time.

  • YEAR -
Default
"YEAR"
Enum
  • YEAR

quantity

int

Quantity of time units.

instrument

object (instrument)

Instrument details.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

short_name

string

Instrument short name.

Max Length
100

venue

object (venue)

Venue details.

name

string

Venue name.

Max Length
100

account

object (account)

Account details.

id

string

uuid

Account unique identifier.

account_number

int

The serial account number of the account in the account group.

Min
1

account_group

object (account_group)

Account group details.

id

string

uuid

Account group unique identifier.

securities_account_number

string

^[0-9]{9}$

Securities account number.

user

object (user)

User details.

first_name

string

First name of the user.

Min Length
2
Max Length
100

last_name

string

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

address

object (address)

User residential address.

address_line1

string

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

Min Length
1
Max Length
85

order

object (order)

Order details.

user_id

string

uuid

The ID of the user.

account_id

string

uuid

The ID of the account that owns the order.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Enum
  • EUR

side

string

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

instrument_id_type

string

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

limit_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

return_impact

object (return_impact)

Return impact.

year_one

object (year_one)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_two

object (year_two)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_three

object (year_three)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total_cost

object (total_cost)

Aggregated totals of product costs, service costs and third party payments.

product

object (product)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service

object (service)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party

object (third_party)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

product_cost

object (product_cost)

All costs and associated charges related to the financial instrument.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service_cost

object (service_cost)

All costs and associated charges related to the investment service(s) and/or ancillary services.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ancillary

object (ancillary)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party_payments

object (third_party_payments)

Third party payments associated with the investment service.

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Create a user report

post /reports

Create a user report

OAuth2 oauth-client-credentials

Required Scopes:

reports:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

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)

Default
"1"
Enum
  • 1
Example
1

Report - Create - Request

One Of

Report - Order ex-ante cost - Create - Request

object (Report - Order ex-ante cost - Create - Request)

The order ex-ante cost report is generated by the client sharing the valid and relevant input data for the order.

type

string

required

The type of report must be “ORDER_EX_ANTE_COST”.

Default
"ORDER_EX_ANTE_COST"

order

object (order)

required

Order details.

user_id

string

uuid

required

The ID of the user.

account_id

string

uuid

required

The ID of the account that owns the order.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

required

Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

limit_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

fees

array[One Of]

Client fees.

Fee

One Of

Absolute Fee

object (Absolute Fee)

type

string

required

Fee type

  • TRANSACTION_FEE_BUY -
  • TRANSACTION_FEE_SELL -
  • ANNUAL_AUM_BASED_FEE -
Enum
  • TRANSACTION_FEE_BUY
  • TRANSACTION_FEE_SELL
  • ANNUAL_AUM_BASED_FEE

value_type

string

required

The type of fee value must be “ABSOLUTE”.

Default
"ABSOLUTE"

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

Relative Fee

object (Relative Fee)

type

string

required

Fee type

  • TRANSACTION_FEE_BUY -
  • TRANSACTION_FEE_SELL -
  • ANNUAL_AUM_BASED_FEE -
Enum
  • TRANSACTION_FEE_BUY
  • TRANSACTION_FEE_SELL
  • ANNUAL_AUM_BASED_FEE

value_type

string

required

The type of fee value must be “RELATIVE”.

Default
"RELATIVE"

bps

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

Request

{
  "type": "ORDER_EX_ANTE_COST",
  "order": {
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
    "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
    "order_type": "MARKET",
    "side": "BUY",
    "instrument_id": "LU0274208692",
    "instrument_id_type": "ISIN",
    "currency": "EUR",
    "quantity": "15"
  },
  "fees": [
    {
      "type": "TRANSACTION_FEE_BUY",
      "value_type": "ABSOLUTE",
      "cash_amount": "0.80",
      "currency": "EUR"
    },
    {
      "type": "TRANSACTION_FEE_SELL",
      "value_type": "ABSOLUTE",
      "cash_amount": "0.95",
      "currency": "EUR"
    },
    {
      "type": "ANNUAL_AUM_BASED_FEE",
      "value_type": "RELATIVE",
      "bps": "37"
    }
  ]
}
{
  "type": "ORDER_EX_ANTE_COST",
  "order": {
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
    "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
    "order_type": "MARKET",
    "side": "SELL",
    "instrument_id": "LU0274208692",
    "instrument_id_type": "ISIN",
    "currency": "EUR",
    "cash_amount": "1000.00"
  },
  "fees": [
    {
      "type": "TRANSACTION_FEE_BUY",
      "value_type": "ABSOLUTE",
      "cash_amount": "1.00",
      "currency": "EUR"
    },
    {
      "type": "TRANSACTION_FEE_SELL",
      "value_type": "ABSOLUTE",
      "cash_amount": "0.90",
      "currency": "EUR"
    },
    {
      "type": "ANNUAL_AUM_BASED_FEE",
      "value_type": "RELATIVE",
      "bps": "10"
    }
  ]
}

Response

Examples Schema

Report

{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2023-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "ORDER_EX_ANTE_COST",
  "substituted_report_id": null,
  "data": {
    "account": {
      "id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "account_number": 1
    },
    "account_group": {
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "securities_account_number": "123456789"
    },
    "user": {
      "salutation": "SALUTATION_MALE",
      "title": "DR",
      "first_name": "Karl",
      "last_name": "Schmidt",
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "postcode": "45678",
        "city": "Berlin",
        "country": "DE"
      }
    },
    "instrument": {
      "isin": "LU0274208692",
      "short_name": "XTR.MSCI WORLD SWAP 1C"
    },
    "venue": {
      "name": "Tradegate"
    },
    "order": {
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
      "instrument_id": "LU0274208692",
      "instrument_id_type": "ISIN",
      "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "order_type": "MARKET",
      "side": "BUY",
      "quantity": "15",
      "cash_amount": "1220.85",
      "currency": "EUR",
      "price": "81.39"
    },
    "holding_period": {
      "unit": "YEAR",
      "quantity": 3
    },
    "total_cost": {
      "product": {
        "cash_amount": "17.48",
        "currency": "EUR",
        "as_percentage": "1.43"
      },
      "service": {
        "cash_amount": "6.88",
        "currency": "EUR",
        "as_percentage": "0.56"
      },
      "third_party": {
        "cash_amount": "0.70",
        "currency": "EUR",
        "as_percentage": "0.06"
      },
      "total": {
        "cash_amount": "25.06",
        "currency": "EUR",
        "as_percentage": "2.05"
      }
    },
    "product_cost": {
      "one_off": {
        "cash_amount": "0.20",
        "currency": "EUR",
        "as_percentage": "0.02"
      },
      "ongoing": {
        "cash_amount": "16.48",
        "currency": "EUR",
        "as_percentage": "1.35"
      },
      "transaction": {
        "cash_amount": "0.80",
        "currency": "EUR",
        "as_percentage": "0.07"
      },
      "incidental": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "total": {
        "cash_amount": "17.48",
        "currency": "EUR",
        "as_percentage": "1.43"
      }
    },
    "service_cost": {
      "one_off": {
        "cash_amount": "0.49",
        "currency": "EUR",
        "as_percentage": "0.04"
      },
      "ongoing": {
        "cash_amount": "4.39",
        "currency": "EUR",
        "as_percentage": "0.36"
      },
      "transaction": {
        "cash_amount": "2.00",
        "currency": "EUR",
        "as_percentage": "0.16"
      },
      "ancillary": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "incidental": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "total": {
        "cash_amount": "6.88",
        "currency": "EUR",
        "as_percentage": "0.56"
      }
    },
    "third_party_payments": {
      "total": {
        "cash_amount": "0.70",
        "currency": "EUR",
        "as_percentage": "0.06"
      }
    },
    "return_impact": {
      "year_one": {
        "cash_amount": "9.05",
        "currency": "EUR",
        "as_percentage": "0.74"
      },
      "year_two": {
        "cash_amount": "6.96",
        "currency": "EUR",
        "as_percentage": "0.57"
      },
      "year_three": {
        "cash_amount": "8.36",
        "currency": "EUR",
        "as_percentage": "0.68"
      }
    }
  }
}

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

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

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

Report

One Of

Report - Order ex-ante cost

object (Report - Order ex-ante cost)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

The type of report must be “ORDER_EX_ANTE_COST”.

Default
"ORDER_EX_ANTE_COST"

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the order ex-ante cost report.

holding_period

object (holding_period)

Holding period.

unit

string

Unit of time.

  • YEAR -
Default
"YEAR"
Enum
  • YEAR

quantity

int

Quantity of time units.

instrument

object (instrument)

Instrument details.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

short_name

string

Instrument short name.

Max Length
100

venue

object (venue)

Venue details.

name

string

Venue name.

Max Length
100

account

object (account)

Account details.

id

string

uuid

Account unique identifier.

account_number

int

The serial account number of the account in the account group.

Min
1

account_group

object (account_group)

Account group details.

id

string

uuid

Account group unique identifier.

securities_account_number

string

^[0-9]{9}$

Securities account number.

user

object (user)

User details.

first_name

string

First name of the user.

Min Length
2
Max Length
100

last_name

string

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

address

object (address)

User residential address.

address_line1

string

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

Min Length
1
Max Length
85

order

object (order)

Order details.

user_id

string

uuid

The ID of the user.

account_id

string

uuid

The ID of the account that owns the order.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Enum
  • EUR

side

string

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

instrument_id_type

string

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

limit_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

return_impact

object (return_impact)

Return impact.

year_one

object (year_one)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_two

object (year_two)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_three

object (year_three)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total_cost

object (total_cost)

Aggregated totals of product costs, service costs and third party payments.

product

object (product)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service

object (service)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party

object (third_party)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

product_cost

object (product_cost)

All costs and associated charges related to the financial instrument.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service_cost

object (service_cost)

All costs and associated charges related to the investment service(s) and/or ancillary services.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ancillary

object (ancillary)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party_payments

object (third_party_payments)

Third party payments associated with the investment service.

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Retrieve a user report

get /reports/{report_id}

Retrieve a user report

OAuth2 oauth-client-credentials

Required Scopes:

reports:readreports:admin

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • prices:read · Read instrument prices
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:admin · Create reports
  • reports:read · Read reports
  • savings_plans:admin · Create/read savings plans
  • savings_plans:read · Read savings plans
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • virtual_cash_balances:admin · Virtual cash balances
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

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)

Default
"1"
Enum
  • 1
Example
1

accept

string

Report format

Default
"application/json"
Enum
  • application/json
  • application/pdf

report_id

string

uuid

required

Report unique identifier.

Response

Examples Schema

Report

{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "BUY_ORDER",
  "substituted_report_id": null,
  "data": {
    "account": {
      "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
    }
  }
}
{
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "created_at": "2023-08-24T14:15:22Z",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
  "type": "ORDER_EX_ANTE_COST",
  "substituted_report_id": null,
  "data": {
    "account": {
      "id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "account_number": 1
    },
    "account_group": {
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "securities_account_number": "123456789"
    },
    "user": {
      "salutation": "SALUTATION_MALE",
      "title": "DR",
      "first_name": "Karl",
      "last_name": "Schmidt",
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "postcode": "45678",
        "city": "Berlin",
        "country": "DE"
      }
    },
    "instrument": {
      "isin": "LU0274208692",
      "short_name": "XTR.MSCI WORLD SWAP 1C"
    },
    "venue": {
      "name": "Tradegate"
    },
    "order": {
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
      "instrument_id": "LU0274208692",
      "instrument_id_type": "ISIN",
      "account_id": "c5034305-c441-4711-adbf-93cfbc13a695",
      "order_type": "MARKET",
      "side": "BUY",
      "quantity": "15",
      "cash_amount": "1220.85",
      "currency": "EUR",
      "price": "81.39"
    },
    "holding_period": {
      "unit": "YEAR",
      "quantity": 3
    },
    "total_cost": {
      "product": {
        "cash_amount": "17.48",
        "currency": "EUR",
        "as_percentage": "1.43"
      },
      "service": {
        "cash_amount": "6.88",
        "currency": "EUR",
        "as_percentage": "0.56"
      },
      "third_party": {
        "cash_amount": "0.70",
        "currency": "EUR",
        "as_percentage": "0.06"
      },
      "total": {
        "cash_amount": "25.06",
        "currency": "EUR",
        "as_percentage": "2.05"
      }
    },
    "product_cost": {
      "one_off": {
        "cash_amount": "0.20",
        "currency": "EUR",
        "as_percentage": "0.02"
      },
      "ongoing": {
        "cash_amount": "16.48",
        "currency": "EUR",
        "as_percentage": "1.35"
      },
      "transaction": {
        "cash_amount": "0.80",
        "currency": "EUR",
        "as_percentage": "0.07"
      },
      "incidental": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "total": {
        "cash_amount": "17.48",
        "currency": "EUR",
        "as_percentage": "1.43"
      }
    },
    "service_cost": {
      "one_off": {
        "cash_amount": "0.49",
        "currency": "EUR",
        "as_percentage": "0.04"
      },
      "ongoing": {
        "cash_amount": "4.39",
        "currency": "EUR",
        "as_percentage": "0.36"
      },
      "transaction": {
        "cash_amount": "2.00",
        "currency": "EUR",
        "as_percentage": "0.16"
      },
      "ancillary": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "incidental": {
        "cash_amount": "0.00",
        "currency": "EUR",
        "as_percentage": "0.00"
      },
      "total": {
        "cash_amount": "6.88",
        "currency": "EUR",
        "as_percentage": "0.56"
      }
    },
    "third_party_payments": {
      "total": {
        "cash_amount": "0.70",
        "currency": "EUR",
        "as_percentage": "0.06"
      }
    },
    "return_impact": {
      "year_one": {
        "cash_amount": "9.05",
        "currency": "EUR",
        "as_percentage": "0.74"
      },
      "year_two": {
        "cash_amount": "6.96",
        "currency": "EUR",
        "as_percentage": "0.57"
      },
      "year_three": {
        "cash_amount": "8.36",
        "currency": "EUR",
        "as_percentage": "0.68"
      }
    }
  }
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

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

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

Report

One Of

Report

object (Report)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

Report type

  • BUY_ORDER - Buy order
  • SELL_ORDER - Sell order
  • INCOME_DISTRIBUTION - Income distribution report
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • FUND_COMMUNICATION - Generic fund communication
  • TAX_REFUND - Tax refund document (after tax optimization)
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • ACCOUNT_OPENING - Securities account opening
  • ACCOUNT_CLOSING - Securities account closure
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • GENERIC_COMMUNICATION - Generic communication
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • EX_POST_COST - Ex-post cost report
  • TAX_OPTIMISATION - Tax optimisation report
Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED
  • AD_HOC_ACCOUNT_STATEMENT
  • EX_POST_COST
  • TAX_OPTIMISATION

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the report.

account

object (account)

Account information.

id

string

uuid

Account unique identifier.

Report - Order ex-ante cost

object (Report - Order ex-ante cost)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

The type of report must be “ORDER_EX_ANTE_COST”.

Default
"ORDER_EX_ANTE_COST"

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the order ex-ante cost report.

holding_period

object (holding_period)

Holding period.

unit

string

Unit of time.

  • YEAR -
Default
"YEAR"
Enum
  • YEAR

quantity

int

Quantity of time units.

instrument

object (instrument)

Instrument details.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

short_name

string

Instrument short name.

Max Length
100

venue

object (venue)

Venue details.

name

string

Venue name.

Max Length
100

account

object (account)

Account details.

id

string

uuid

Account unique identifier.

account_number

int

The serial account number of the account in the account group.

Min
1

account_group

object (account_group)

Account group details.

id

string

uuid

Account group unique identifier.

securities_account_number

string

^[0-9]{9}$

Securities account number.

user

object (user)

User details.

first_name

string

First name of the user.

Min Length
2
Max Length
100

last_name

string

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

address

object (address)

User residential address.

address_line1

string

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

Min Length
1
Max Length
85

order

object (order)

Order details.

user_id

string

uuid

The ID of the user.

account_id

string

uuid

The ID of the account that owns the order.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Enum
  • EUR

side

string

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

instrument_id_type

string

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

limit_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

return_impact

object (return_impact)

Return impact.

year_one

object (year_one)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_two

object (year_two)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_three

object (year_three)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total_cost

object (total_cost)

Aggregated totals of product costs, service costs and third party payments.

product

object (product)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service

object (service)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party

object (third_party)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

product_cost

object (product_cost)

All costs and associated charges related to the financial instrument.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service_cost

object (service_cost)

All costs and associated charges related to the investment service(s) and/or ancillary services.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ancillary

object (ancillary)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party_payments

object (third_party_payments)

Third party payments associated with the investment service.

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

Report

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

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.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

User reports events

webhook

User reports events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

type

string

required

Event type

Default
"REPORT.CREATED"
Enum
  • REPORT.CREATED

object

One Of

required

Report

object (Report)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

Report type

  • BUY_ORDER - Buy order
  • SELL_ORDER - Sell order
  • INCOME_DISTRIBUTION - Income distribution report
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • FUND_COMMUNICATION - Generic fund communication
  • TAX_REFUND - Tax refund document (after tax optimization)
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • ACCOUNT_OPENING - Securities account opening
  • ACCOUNT_CLOSING - Securities account closure
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • GENERIC_COMMUNICATION - Generic communication
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
  • AD_HOC_ACCOUNT_STATEMENT - Ad hoc account statement
  • EX_POST_COST - Ex-post cost report
  • TAX_OPTIMISATION - Tax optimisation report
Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED
  • AD_HOC_ACCOUNT_STATEMENT
  • EX_POST_COST
  • TAX_OPTIMISATION

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the report.

account

object (account)

Account information.

id

string

uuid

Account unique identifier.

Report - Order ex-ante cost

object (Report - Order ex-ante cost)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

user_id

string

uuid

required

User unique identifier.

type

string

required

The type of report must be “ORDER_EX_ANTE_COST”.

Default
"ORDER_EX_ANTE_COST"

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the order ex-ante cost report.

holding_period

object (holding_period)

Holding period.

unit

string

Unit of time.

  • YEAR -
Default
"YEAR"
Enum
  • YEAR

quantity

int

Quantity of time units.

instrument

object (instrument)

Instrument details.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

short_name

string

Instrument short name.

Max Length
100

venue

object (venue)

Venue details.

name

string

Venue name.

Max Length
100

account

object (account)

Account details.

id

string

uuid

Account unique identifier.

account_number

int

The serial account number of the account in the account group.

Min
1

account_group

object (account_group)

Account group details.

id

string

uuid

Account group unique identifier.

securities_account_number

string

^[0-9]{9}$

Securities account number.

user

object (user)

User details.

first_name

string

First name of the user.

Min Length
2
Max Length
100

last_name

string

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

address

object (address)

User residential address.

address_line1

string

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

Min Length
1
Max Length
85

order

object (order)

Order details.

user_id

string

uuid

The ID of the user.

account_id

string

uuid

The ID of the account that owns the order.

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Enum
  • EUR

side

string

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

instrument_id_type

string

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

Type of the order.

  • MARKET -
  • LIMIT -
  • STOP -
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

limit_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

stop_price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

price

string

^[0-9]{0,63}(\.[0-9]{1,27})?$

return_impact

object (return_impact)

Return impact.

year_one

object (year_one)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_two

object (year_two)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

year_three

object (year_three)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total_cost

object (total_cost)

Aggregated totals of product costs, service costs and third party payments.

product

object (product)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service

object (service)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party

object (third_party)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

product_cost

object (product_cost)

All costs and associated charges related to the financial instrument.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

service_cost

object (service_cost)

All costs and associated charges related to the investment service(s) and/or ancillary services.

one_off

object (one_off)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ongoing

object (ongoing)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

transaction

object (transaction)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

ancillary

object (ancillary)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

incidental

object (incidental)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

third_party_payments

object (third_party_payments)

Third party payments associated with the investment service.

total

object (total)

cash_amount

string

^[0-9]{1,9}(\.[0-9]{2})?$

currency

string

ISO4217

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

as_percentage

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "REPORT.CREATED",
  "object": {
    "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
    "created_at": "2020-08-24T14:15:22Z",
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5",
    "type": "BUY_ORDER",
    "substituted_report_id": null,
    "data": {
      "account": {
        "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
      }
    }
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Was this page helpful?