Account Groups

Download Spec

All account groups related paths

Get an account group by ID

get /account_groups/{account_group_id}

Returns the account group specified bu its ID.

OAuth2 oauth-client-credentials

Required Scopes:

accounts:readaccounts:admin

All Scopes

account_liquidations:admin · Trigger/read/cancel accounts liquidations
account_liquidations:read · Read accounts liquidations
account_returns:read · Read accounts returns
accounts:admin · Create/update/delete accounts and account groups
accounts:read · Read accounts and account groups
checks:admin · Create checks
checks:read · Read checks
credit_fundings:read · Credit Fundings read operations
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
prices:read · Read instrument prices
reference_accounts:admin · Create/update/delete reference accounts
reference_accounts:read · Read reference accounts
reports:admin · Create reports
reports:read · Read reports
savings_plans:admin · Create/read savings plans
savings_plans:read · Read savings plans
taxes:admin · Modify tax residencies
taxes:read · Read tax residencies
topups:admin · Topups operations
topups:read · Topups read operations
transactions:read · Read cash and securities transactions
users:admin · Create/update/delete users
users:read · Read users
valuations:read · Read valuations
virtual_cash_balances:admin · Virtual cash balances
webhooks:admin · Create/update/delete webhooks
webhooks:read · Read webhooks

Flow Type:: Client Credentials

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

upvest-client-id

string

uuid

required

Tenant Client ID

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

authorization

string

^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=="

signature

string

required

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

signature-input

string

required

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

upvest-api-version

string

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

Default: "1"
Enum: 1
Example: 1

account_group_id

string

uuid

required

Account group unique identifier.

Response

Examples Schema

{
  "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": [
    {
      "id": "413715f2-5401-4b97-8055-034a6b879f8c",
      "type": "OWNER"
    }
  ],
  "securities_account_number": "123456789"
}

Unauthorized. The caller has not been authenticated.

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

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

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

Not Found. The requested resource could not be found.

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

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

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

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

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

Internal Server Error. The service encountered an unexpected error.

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

Service Unavailable. The service handling for this request cannot be reached at this time.

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

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

string

uuid

required

Account group unique identifier.

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

users

array[object]

required

object

string

uuid

User unique identifier.

type

string

Relation type

OWNER -

Default: "OWNER"
Enum: OWNER

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

securities_account_number

string

^[0-9]{9}$

required

Securities account number

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

Close an account group by ID

delete /account_groups/{account_group_id}

Initiates the closure request for an account group specified by its ID.

OAuth2 oauth-client-credentials

Required Scopes:

accounts:admin

All Scopes

account_liquidations:admin · Trigger/read/cancel accounts liquidations
account_liquidations:read · Read accounts liquidations
account_returns:read · Read accounts returns
accounts:admin · Create/update/delete accounts and account groups
accounts:read · Read accounts and account groups
checks:admin · Create checks
checks:read · Read checks
credit_fundings:read · Credit Fundings read operations
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
prices:read · Read instrument prices
reference_accounts:admin · Create/update/delete reference accounts
reference_accounts:read · Read reference accounts
reports:admin · Create reports
reports:read · Read reports
savings_plans:admin · Create/read savings plans
savings_plans:read · Read savings plans
taxes:admin · Modify tax residencies
taxes:read · Read tax residencies
topups:admin · Topups operations
topups:read · Topups read operations
transactions:read · Read cash and securities transactions
users:admin · Create/update/delete users
users:read · Read users
valuations:read · Read valuations
virtual_cash_balances:admin · Virtual cash balances
webhooks:admin · Create/update/delete webhooks
webhooks:read · Read webhooks

Flow Type:: Client Credentials

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

upvest-client-id

string

uuid

required

Tenant Client ID

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

authorization

string

^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=="

signature

string

required

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

signature-input

string

required

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

upvest-api-version

string

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

Default: "1"
Enum: 1
Example: 1

account_group_id

string

uuid

required

Account group unique identifier.

Response

Examples Schema

The request has been successfully accepted and will be processed asynchronously.

Empty response

Unauthorized. The caller has not been authenticated.

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

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

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

Not Found. The requested resource could not be found.

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

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

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

Conflict. An operation is not available for the current state of the resource.

{
  "status": 409,
  "type": "conflict"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

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

Internal Server Error. The service encountered an unexpected error.

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

Service Unavailable. The service handling for this request cannot be reached at this time.

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

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

No schema

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

Get account groups

get /account_groups

Returns a list of all account groups.

OAuth2 oauth-client-credentials

Required Scopes:

accounts:readaccounts:admin

All Scopes

account_liquidations:admin · Trigger/read/cancel accounts liquidations
account_liquidations:read · Read accounts liquidations
account_returns:read · Read accounts returns
accounts:admin · Create/update/delete accounts and account groups
accounts:read · Read accounts and account groups
checks:admin · Create checks
checks:read · Read checks
credit_fundings:read · Credit Fundings read operations
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
prices:read · Read instrument prices
reference_accounts:admin · Create/update/delete reference accounts
reference_accounts:read · Read reference accounts
reports:admin · Create reports
reports:read · Read reports
savings_plans:admin · Create/read savings plans
savings_plans:read · Read savings plans
taxes:admin · Modify tax residencies
taxes:read · Read tax residencies
topups:admin · Topups operations
topups:read · Topups read operations
transactions:read · Read cash and securities transactions
users:admin · Create/update/delete users
users:read · Read users
valuations:read · Read valuations
virtual_cash_balances:admin · Virtual cash balances
webhooks:admin · Create/update/delete webhooks
webhooks:read · Read webhooks

Flow Type:: Client Credentials

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

upvest-client-id

string

uuid

required

Tenant Client ID

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

authorization

string

^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=="

signature

string

required

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

signature-input

string

required

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

upvest-api-version

string

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

Default: "1"
Enum: 1
Example: 1

sort

string

Sort the result by created_at.

Default: "created_at"
Enum: created_at

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default: "ASC"
Enum: ASC

offset

int

i32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min: 0

limit

int

i32

Use the limit argument to specify the maximum number of items returned.

Default: 100
Min: 0
Max: 1000

Response

Examples Schema

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "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": [
        {
          "id": "9c36af78-91a0-4174-a515-fc81214e3dab",
          "type": "OWNER"
        }
      ],
      "securities_account_number": "123456789"
    }
  ]
}

Bad Request. The incoming request had a malformed parameter/object.

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

Unauthorized. The caller has not been authenticated.

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

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

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

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

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

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

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

Internal Server Error. The service encountered an unexpected error.

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

Service Unavailable. The service handling for this request cannot be reached at this time.

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

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

Create an account group

post /account_groups

Creates an account group.

OAuth2 oauth-client-credentials

Required Scopes:

accounts:admin

All Scopes

account_liquidations:admin · Trigger/read/cancel accounts liquidations
account_liquidations:read · Read accounts liquidations
account_returns:read · Read accounts returns
accounts:admin · Create/update/delete accounts and account groups
accounts:read · Read accounts and account groups
checks:admin · Create checks
checks:read · Read checks
credit_fundings:read · Credit Fundings read operations
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
prices:read · Read instrument prices
reference_accounts:admin · Create/update/delete reference accounts
reference_accounts:read · Read reference accounts
reports:admin · Create reports
reports:read · Read reports
savings_plans:admin · Create/read savings plans
savings_plans:read · Read savings plans
taxes:admin · Modify tax residencies
taxes:read · Read tax residencies
topups:admin · Topups operations
topups:read · Topups read operations
transactions:read · Read cash and securities transactions
users:admin · Create/update/delete users
users:read · Read users
valuations:read · Read valuations
virtual_cash_balances:admin · Virtual cash balances
webhooks:admin · Create/update/delete webhooks
webhooks:read · Read webhooks

Flow Type:: Client Credentials

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

upvest-client-id

string

uuid

required

Tenant Client ID

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

authorization

string

^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=="

signature

string

required

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

signature-input

string

required

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

upvest-api-version

string

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

Default: "1"
Enum: 1
Example: 1

idempotency-key

string

uuid

^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$

required

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

Example: "ccb07f42-4104-44ad-8e1f-c660bb7b269c"

user_id

string

uuid

required

User unique identifier.

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

Request

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

Response

Examples Schema

Account group created.

{
  "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": [
    {
      "id": "413715f2-5401-4b97-8055-034a6b879f8c",
      "type": "OWNER"
    }
  ],
  "securities_account_number": "123456789"
}

Bad Request. The incoming request had a malformed parameter/object.

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

Unauthorized. The caller has not been authenticated.

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

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

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

Not Found. The requested resource could not be found.

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

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

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

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

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

Internal Server Error. The service encountered an unexpected error.

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

Service Unavailable. The service handling for this request cannot be reached at this time.

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

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

string

uuid

required

Account group unique identifier.

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

users

array[object]

required

object

string

uuid

User unique identifier.

type

string

Relation type

OWNER -

Default: "OWNER"
Enum: OWNER

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

securities_account_number

string

^[0-9]{9}$

required

Securities account number

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example: "169ae4c7-ebd7-4041-94da-25369653eba7"

Account group events

webhook

Account group events

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Enum: ACCOUNT_GROUP.CREATED

ACCOUNT_GROUP.ACTIVATED

ACCOUNT_GROUP.CLOSING_INITIATED

ACCOUNT_GROUP.CLOSED

ACCOUNT_GROUP.LOCKED

object

object (object)

required

string

uuid

required

Account group unique identifier.

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

users

array[object]

required

object

string

uuid

User unique identifier.

type

string

Relation type

OWNER -

Default: "OWNER"
Enum: OWNER

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

securities_account_number

string

^[0-9]{9}$

required

Securities account number

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "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": [
      {
        "id": "413715f2-5401-4b97-8055-034a6b879f8c",
        "type": "OWNER"
      }
    ],
    "securities_account_number": "123456789"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Was this page helpful?