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

Request

Creates an account group.

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.

typestringrequired

Account group type.

  • PERSONAL - Account group of a person holding assets on their own behalf.
  • LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users.
  • FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions.
  • ISA - Account group of a UK resident holding assets in an individual savings account.
  • CHILD - Account group of a child user holding assets in a child account.
Enum"PERSONAL""LEGAL_ENTITY""FRENCH_PEA""ISA""CHILD"
curl -i -X POST \
  https://sandbox.upvest.co/account_groups \
  -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",
    "type": "PERSONAL"
  }'

Responses

Account group created.

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

Account group 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

usersArray of objectsrequired
idstring(uuid)

User unique identifier.

typestring

Relation type

  • OWNER -
Default "OWNER"
Value"OWNER"
statusstringrequired

Status of the account group

  • PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on.
  • ACTIVE - Account group is active - full functionality of the Investment API is accessible.
  • CLOSING - Account group is closing.
  • CLOSED - Account group is closed.
  • LOCKED - Account group is locked for all actions.
Enum"PENDING_APPROVAL""ACTIVE""CLOSING""CLOSED""LOCKED"
typestringrequired

Account group type.

  • PERSONAL - Account group of a person holding assets on their own behalf.
  • LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users.
  • FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions.
  • ISA - Account group of a UK resident holding assets in an individual savings account.
  • CHILD - Account group of a child user holding assets in a child account.
Enum"PERSONAL""LEGAL_ENTITY""FRENCH_PEA""ISA""CHILD"
securities_account_numberstring^[0-9]{9}$required

Securities account number

Response
application/json
{ "id": "9d95820d-4333-46b6-98de-04ab7512e76f", "created_at": "2020-08-24T14:15:22Z", "updated_at": "2020-08-24T14:15:22Z", "type": "PERSONAL", "status": "ACTIVE", "users": [ { … } ], "securities_account_number": "123456789" }

Request

Account group 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_GROUP.CREATED""ACCOUNT_GROUP.ACTIVATED""ACCOUNT_GROUP.CLOSING_INITIATED""ACCOUNT_GROUP.CLOSED""ACCOUNT_GROUP.LOCKED"
objectobjectrequired
idstring(uuid)required

Account group 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

usersArray of objectsrequired
idstring(uuid)

User unique identifier.

typestring

Relation type

  • OWNER -
Default "OWNER"
Value"OWNER"
statusstringrequired

Status of the account group

  • PENDING_APPROVAL - Account group approval is pending - the account group is visible through our API but cannot be acted on.
  • ACTIVE - Account group is active - full functionality of the Investment API is accessible.
  • CLOSING - Account group is closing.
  • CLOSED - Account group is closed.
  • LOCKED - Account group is locked for all actions.
Enum"PENDING_APPROVAL""ACTIVE""CLOSING""CLOSED""LOCKED"
typestringrequired

Account group type.

  • PERSONAL - Account group of a person holding assets on their own behalf.
  • LEGAL_ENTITY - Account group of a legal entity holding assets on behalf of their users.
  • FRENCH_PEA - Account group of a french resident holding assets in Plan d'Epargne en Actions.
  • ISA - Account group of a UK resident holding assets in an individual savings account.
  • CHILD - Account group of a child user holding assets in a child account.
Enum"PERSONAL""LEGAL_ENTITY""FRENCH_PEA""ISA""CHILD"
securities_account_numberstring^[0-9]{9}$required

Securities account number

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{ "id": "72da9e41-9926-419f-976e-4c8069a04249", "created_at": "2021-07-21T14:10:00.00Z", "type": "ACCOUNT_GROUP.CREATED", "object": { "id": "9d95820d-4333-46b6-98de-04ab7512e76f", "created_at": "2020-08-24T14:15:22Z", "updated_at": "2020-08-24T14:15:22Z", "type": "PERSONAL", "status": "ACTIVE", "users": [ … ], "securities_account_number": "123456789" }, "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6" }

Responses

Request has been processed successfully.

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

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