Skip to content
API Reference/
/
Account events

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
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

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Create an account

Request

Creates an account.

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
user_idstring(uuid)required

User unique identifier.

account_group_idstring(uuid)required

Account group unique identifier.

typestringrequired

Account type.

  • TRADING - Orders in accounts of this type are created on a specific instrument basis.
  • PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
Enum"TRADING""PORTFOLIO"
namestring<= 100 characters

The name of the account.

curl -i -X POST \
  https://sandbox.upvest.co/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": "413715f2-5401-4b97-8055-034a6b879f8c",
    "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
    "type": "TRADING",
    "name": "Main account"
  }'

Responses

Account created.

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

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

account_group_idstring(uuid)required

Account group unique identifier.

typestringrequired

Account type.

  • TRADING - Orders in accounts of this type are created on a specific instrument basis.
  • PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
Enum"TRADING""PORTFOLIO"
usersArray of objectsrequired
idstring(uuid)

User unique identifier.

typestring

Relation type

  • OWNER -
Default "OWNER"
Value"OWNER"
namestring<= 100 charactersrequired

The name of the account.

statusstringrequired

The status of the account

  • PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on.
  • ACTIVE - Account is active - full functionality of the Investment API is accessible.
  • CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed.
  • CLOSED - Account is closed with zero balance successfully.
  • LOCKED - Account is locked for all actions.
Enum"PENDING_APPROVAL""ACTIVE""CLOSING""CLOSED""LOCKED"
account_numberinteger>= 1required

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

Response
application/json
{
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "created_at": "2020-08-24T14:15:22Z",
  "updated_at": "2020-08-24T14:15:22Z",
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "type": "TRADING",
  "users": [
    { … }
  ],
  "account_number": 1,
  "name": "Main account",
  "status": "ACTIVE"
}

Account eventsWebhook

Request

Account events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

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

typestringrequired

Event type

Enum"ACCOUNT.CREATED""ACCOUNT.ACTIVATED""ACCOUNT.CLOSING_INITIATED""ACCOUNT.CLOSED""ACCOUNT.LOCKED""ACCOUNT.UPDATED"
objectobjectrequired
idstring(uuid)required

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

account_group_idstring(uuid)required

Account group unique identifier.

typestringrequired

Account type.

  • TRADING - Orders in accounts of this type are created on a specific instrument basis.
  • PORTFOLIO - Orders in accounts of this type are created on a portfolio basis and additional portfolio functionality is available.
Enum"TRADING""PORTFOLIO"
usersArray of objectsrequired
idstring(uuid)

User unique identifier.

typestring

Relation type

  • OWNER -
Default "OWNER"
Value"OWNER"
namestring<= 100 charactersrequired

The name of the account.

statusstringrequired

The status of the account

  • PENDING_APPROVAL - Account approval is pending - the account is visible through our API but cannot be acted on.
  • ACTIVE - Account is active - full functionality of the Investment API is accessible.
  • CLOSING - Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed.
  • CLOSED - Account is closed with zero balance successfully.
  • LOCKED - Account is locked for all actions.
Enum"PENDING_APPROVAL""ACTIVE""CLOSING""CLOSED""LOCKED"
account_numberinteger>= 1required

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

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "56510309-d9de-4730-9b5b-4a0ed047f3a9",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "ACCOUNT.CREATED",
  "object": {
    "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
    "created_at": "2020-08-24T14:15:22Z",
    "updated_at": "2020-08-24T14:15:22Z",
    "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
    "type": "TRADING",
    "users": [ … ],
    "account_number": 1,
    "name": "Main account",
    "status": "ACTIVE"
  },
  "webhook_id": "b838bde5-b6df-4f1f-bfc4-71d3fb01d430"
}

Responses

Request has been processed successfully.

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

Orders

All order related paths.

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

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

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

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations