Skip to content

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations
OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations
OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks
OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Request

Creates a new reference account for a user specified by ID.

Security
oauth-client-credentials
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^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==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

idempotency-keystring(uuid)^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-f...required

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Example: ccb07f42-4104-44ad-8e1f-c660bb7b269c
upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
Bodyapplication/json
account_ownerstring<= 140 charactersrequired

First and last name of the reference account owner

ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$required

International Bank Account Number IBAN.

bicstring^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

confirmed_atstring(date-time)required

Timestamp of when user validated the reference account

user_idstring(uuid)

User unique identifier.

namestring<= 100 characters

Human-readable name of the reference bank account

curl -i -X POST \
  https://sandbox.upvest.co/payments/reference_accounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
  -d '{
    "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
    "account_owner": "Max Mustermann",
    "name": "Max'\''s Reference Account",
    "iban": "DE02100500000054540402",
    "bic": "BELADEBE",
    "confirmed_at": "2020-08-23T14:15:22Z"
  }'

Responses

Reference account created.

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required

Reference account unique identifier.

created_atstring(date-time)required

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

updated_atstring(date-time)required

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

user_idstring(uuid)required

User unique identifier.

account_ownerstring<= 140 charactersrequired

First and last name of the reference account owner

namestring<= 100 charactersrequired

Human-readable name of the reference bank account

ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\*{10}[A-Z0-9]{4}...required

Obfuscated International Bank Account Number IBAN.

bicstring^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

confirmed_atstring(date-time)required

Timestamp of when user validated the reference account

Response
application/json
{ "id": "c18f80bd-401e-4836-9776-7dc24c32d35e", "created_at": "2020-08-24T14:15:22Z", "updated_at": "2020-08-24T14:15:22Z", "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "account_owner": "Max Mustermann", "name": "Max's Reference Account", "iban": "DE0210**********0402", "bic": "BELADEBE", "confirmed_at": "2020-08-23T14:15:22Z" }

Request

Retrieves the reference account specified by its ID.

Security
oauth-client-credentials
Path
reference_account_idstring(uuid)required

Reference account unique identifier.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^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==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
curl -i -X GET \
  'https://sandbox.upvest.co/payments/reference_accounts/{reference_account_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'

Responses

OK

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required

Reference account unique identifier.

created_atstring(date-time)required

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

updated_atstring(date-time)required

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

user_idstring(uuid)required

User unique identifier.

account_ownerstring<= 140 charactersrequired

First and last name of the reference account owner

namestring<= 100 charactersrequired

Human-readable name of the reference bank account

ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{2}\*{10}[A-Z0-9]{4}...required

Obfuscated International Bank Account Number IBAN.

bicstring^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

confirmed_atstring(date-time)required

Timestamp of when user validated the reference account

Response
application/json
{ "id": "c18f80bd-401e-4836-9776-7dc24c32d35e", "created_at": "2020-08-24T14:15:22Z", "updated_at": "2020-08-24T14:15:22Z", "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "account_owner": "Max Mustermann", "name": "Max's Reference Account", "iban": "DE0210**********0402", "bic": "BELADEBE", "confirmed_at": "2020-08-23T14:15:22Z" }

Request

Deletes the reference account specified by its ID.

Security
oauth-client-credentials
Path
reference_account_idstring(uuid)required

Reference account unique identifier.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^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==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
curl -i -X DELETE \
  'https://sandbox.upvest.co/payments/reference_accounts/{reference_account_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'

Responses

Request has been processed successfully.

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Response
No content

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks
OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations
OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks
Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks
Operations