Accounts

List user account groups

get /users/{user_id}/account_groups

List user account groups

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

accounts:readaccounts:admin

Show details +

All Scopes

accounts:admin · Create/update/delete accounts and account groups
accounts:read · Read accounts and account groups
checks:admin · Create checks
checks:read · Read checks
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
reference_accounts:admin · Create/update/delete reference accounts
reference_accounts:read · Read reference accounts
reports:read · Read reports
taxes:admin · Modify tax residencies
taxes:read · Read tax residencies
users:admin · Create/update/delete users
users:read · Read users
valuations:read · Read valuations
webhooks:admin · Create/update/delete webhooks
webhooks:read · Read webhooks

Flow Type:: Client Credentials

Token URL:: https://sandbox.upvest.co/auth/token

Headers

upvest-client-id

string

uuid

required

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

authorization

string

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

required

Example: "Bearer c2VjcmV0Cg=="

signature

string

required

signature-input

string

required

upvest-api-version

string

Default: "1"
Enum: 1

Path Parameters

user_id

string

uuid

required

User unique identifier.

Query Parameters

sort

string

Default: "created_at"
Enum: created_at

order

string

Default: "ASC"
Enum: ASC

offset

int

i32

Min: 0

limit

int

i32

Default: 100
Min: 0
Max: 1000

Response Examples

200 application/json

{
  "data": [
    {
      "created_at": "2020-08-24T14:15:22Z",
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "securities_account_number": "123456789",
      "status": "ACTIVE",
      "type": "PERSONAL",
      "updated_at": "2020-08-24T14:15:22Z",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Retrieve an account group

get /account_groups/{account_group_id}

Retrieve an account group

Response Examples

200 application/json

{
  "created_at": "2020-08-24T14:15:22Z",
  "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
  "securities_account_number": "123456789",
  "status": "ACTIVE",
  "type": "PERSONAL",
  "updated_at": "2020-08-24T14:15:22Z",
  "users": [
    {
      "id": "413715f2-5401-4b97-8055-034a6b879f8c",
      "type": "OWNER"
    }
  ]
}

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Account group closure

delete /account_groups/{account_group_id}

Initiate closure request for an account group

Response Examples

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

List user accounts

get /users/{user_id}/accounts

List user accounts

Response Examples

200 application/json

{
  "data": [
    {
      "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
      "account_number": 1,
      "created_at": "2020-08-24T14:15:22Z",
      "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
      "name": "Main account",
      "status": "ACTIVE",
      "type": "TRADING",
      "updated_at": "2020-08-24T14:15:22Z",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Retrieve user account

get /accounts/{account_id}

Retrieve user account

Response Examples

200 application/json

{
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "account_number": 1,
  "created_at": "2020-08-24T14:15:22Z",
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "name": "Main account",
  "status": "ACTIVE",
  "type": "TRADING",
  "updated_at": "2020-08-24T14:15:22Z",
  "users": [
    {
      "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
      "type": "OWNER"
    }
  ]
}

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Account closure

delete /accounts/{account_id}

Initiate closure request for an account

Response Examples

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Update user account

patch /accounts/{account_id}

Update user account

Request Examples

application/json

{
  "name": "Main account"
}

Response Examples

200 application/json

{
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "account_number": 1,
  "created_at": "2020-08-24T14:15:22Z",
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "name": "Main account",
  "status": "ACTIVE",
  "type": "TRADING",
  "updated_at": "2020-08-24T14:15:22Z",
  "users": [
    {
      "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
      "type": "OWNER"
    }
  ]
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

List account groups

get /account_groups

List account groups

Response Examples

200 application/json

{
  "data": [
    {
      "created_at": "2020-08-24T14:15:22Z",
      "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
      "securities_account_number": "123456789",
      "status": "ACTIVE",
      "type": "PERSONAL",
      "updated_at": "2020-08-24T14:15:22Z",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Create account group

post /account_groups

Create account group

Request Examples

application/json

{
  "type": "PERSONAL",
  "user_id": "413715f2-5401-4b97-8055-034a6b879f8c"
}

Response Examples

200 application/json

{
  "created_at": "2020-08-24T14:15:22Z",
  "id": "9d95820d-4333-46b6-98de-04ab7512e76f",
  "securities_account_number": "123456789",
  "status": "ACTIVE",
  "type": "PERSONAL",
  "updated_at": "2020-08-24T14:15:22Z",
  "users": [
    {
      "id": "413715f2-5401-4b97-8055-034a6b879f8c",
      "type": "OWNER"
    }
  ]
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

List accounts

get /accounts

List accounts

Response Examples

200 application/json

{
  "data": [
    {
      "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
      "account_number": 1,
      "created_at": "2020-08-24T14:15:22Z",
      "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
      "name": "Main account",
      "status": "ACTIVE",
      "type": "TRADING",
      "updated_at": "2020-08-24T14:15:22Z",
      "users": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ]
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Create account

post /accounts

Create account

Request Examples

application/json

{
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "name": "Main account",
  "type": "TRADING",
  "user_id": "413715f2-5401-4b97-8055-034a6b879f8c"
}

Response Examples

200 application/json

{
  "account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
  "account_number": 1,
  "created_at": "2020-08-24T14:15:22Z",
  "id": "ad45b27f-c0e7-4cfb-b48c-a83670dbdfbd",
  "name": "Main account",
  "status": "ACTIVE",
  "type": "TRADING",
  "updated_at": "2020-08-24T14:15:22Z",
  "users": [
    {
      "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
      "type": "OWNER"
    }
  ]
}

400 application/problem+json

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

401 application/problem+json

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

403 application/problem+json

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

404 application/problem+json

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

406 application/problem+json

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

429 application/problem+json

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

500 application/problem+json

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

503 application/problem+json

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

Account Group events

webhook

Account Group events

Request Body

application/json

created_at

string

date-time

required

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

id

string

uuid

required

Event unique identifier

object

object (object)

required

Show child attributes +

created_at

string

date-time

required

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

id

string

uuid

required

Account group unique identifier.

securities_account_number

string

^[0-9]{9}$

required

Securities account number

status

string

required

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

type

string

required

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.

Enum: PERSONAL

LEGAL_ENTITY

updated_at

string

date-time

required

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

users

array[object]

required

Show child attributes +

object

Show child attributes +

id

string

uuid

User unique identifier.

type

string

Relation type

OWNER -

Default: "OWNER"
Enum: OWNER

type

string

required

Event type

Enum: ACCOUNT_GROUP.CREATED

ACCOUNT_GROUP.ACTIVATED

ACCOUNT_GROUP.CLOSING_INITIATED

ACCOUNT_GROUP.CLOSED

ACCOUNT_GROUP.LOCKED

webhook_id

string

uuid

required

Webhook unique identifier.

Responses

204

Request has been processed successfully.

Request Examples

application/json

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

Account events

webhook

Account events

Request Body

application/json

created_at

string

date-time

required

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

id

string

uuid

required

Event unique identifier

object

object (object)

required

Show child attributes +

account_group_id

string

uuid

required

Account group unique identifier.

account_number

int

required

Serial account number of the account in the account group

Min: 1

created_at

string

date-time

required

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

id

string

uuid

required

Account unique identifier.

name

string

required

Nickname of the account

Max Length: 100

status

string

required

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

type

string

required

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

updated_at

string

date-time

required

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

users

array[object]

required

Show child attributes +

object

Show child attributes +

id

string

uuid

User unique identifier.

type

string

Relation type

OWNER -

Default: "OWNER"
Enum: OWNER

type

string

required

Event type

Enum: ACCOUNT.CREATED

ACCOUNT.ACTIVATED

ACCOUNT.CLOSING_INITIATED

ACCOUNT.CLOSED

ACCOUNT.LOCKED

ACCOUNT.UPDATED

webhook_id

string

uuid

required

Webhook unique identifier.

Responses

204

Request has been processed successfully.

Request Examples

application/json

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

List user account groups

Authentication

Headers

Path Parameters

Query Parameters

Responses

Response Headers

Response: application/json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Examples

Retrieve an account group

Authentication

Headers

Path Parameters

Responses

Response Headers

Response: application/json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Examples

Account group closure

Authentication

Headers

Path Parameters

Responses

Response Headers

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Headers

Response: application/problem+json

Response Examples

List user accounts

Authentication

Headers

Path Parameters

Query Parameters

Responses

Response Headers

Response: application/json

Response Headers

Response: application/problem+json

Response Headers