Skip to content
/Access Tokens

Upvest Investment API (1.76.1)

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

Get an access token for requested scopes

Request

Get an access token to use with the API with specified scopes.

You should always scope your access tokens. You get one for read-access and separate ones for updating, creating or deleting resources.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
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
Bodyapplication/x-www-form-urlencoded
client_idstring(uuid)required

Client ID given during onboarding.

client_secretstring<= 1000 charactersrequired

Client Secret given during onboarding.

grant_typestringrequired

This must always be client_credentials.

Default "client_credentials"
scopestring<= 1000 charactersrequired

List of space delimited scopes to request for this access token.

curl -i -X POST \
  https://sandbox.upvest.co/auth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
  -d client_id=5b3fa7ba-57d3-4017-a65b-d57dcd2db643 \
  -d client_secret=string \
  -d grant_type=client_credentials \
  -d scope=string

Responses

Access token successfully generated.

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

The generated access token.

expires_inintegerrequired

How many seconds the access token is valid for.

token_typestringrequired

This is always 'bearer'.

Default "bearer"
scopestring<= 1000 charactersrequired

List of space delimited scopes requested for this access token.

Response
application/json
{
  "access_token": "token.signature",
  "expires_in": 86400,
  "token_type": "bearer",
  "scope": "users:read"
}

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

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 Wrappers

All tax wrappers related paths

OperationsWebhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

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

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Credit Fundings

All credit fundings related paths

OperationsWebhooks

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

Tests

All test related paths.

Operations