Upvest API Documentation
Operating Model:
Upvest API Documentation
Operating Model:

Users

Download Spec

All user related paths.

Get all users

get /users

Returns the list of all users.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

users:readusers:admin

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
  • 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
  • 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
  • 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
  • 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

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

One Of

required

Any Of

Users (BYOL) - List

array[object (User (BYOL))]

User (BYOL)

object (User (BYOL))

id

string

uuid

required

User 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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

Users (TOL) - List

array[object (User (TOL))]

User (TOL)

object (User (TOL))

id

string

uuid

required

User 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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

email

string

email

Email of the user. Must be a valid email address.

Max Length
100

phone_number

string

^([0-9]{8,15})?$

Phone number of the user. Phone number E.164 format.

fatca

object (fatca)

status

boolean

required

The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

terms_and_conditions

object (terms_and_conditions)

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the terms & conditions. RFC 3339-5, ISO8601 UTC

data_privacy_and_sharing_agreement

object (data_privacy_and_sharing_agreement)

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the data sharing agreement. RFC 3339-5, ISO8601 UTC

empty Users - List

array[object]

For empty lists, JSON schema's 'oneOf' matches both 'Users (BYOL) - List' and 'Users (TOL) - List' and hence fails. So we need this extra 'oneOf' branch specifically for empty lists, distinguished by 'minItems' and 'maxItems'.

object

All items on list responses must be objects.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "data": [
    {
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "city": "Berlin",
        "country": "DE",
        "postcode": "45678",
        "state": "BE"
      },
      "birth_city": "Berlin",
      "birth_country": "DE",
      "birth_date": "1972-09-30",
      "birth_name": "Schmidt",
      "created_at": "2021-07-21T14:10:00.00Z",
      "first_name": "Karl",
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "last_name": "Schmidt",
      "nationalities": [
        "DE",
        "AU"
      ],
      "postal_address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "city": "Berlin",
        "country": "DE",
        "postcode": "45678",
        "state": "BE"
      },
      "salutation": "SALUTATION_MALE",
      "status": "ACTIVE",
      "title": "DR",
      "updated_at": "2021-07-21T14:10:00.00Z"
    },
    {
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "city": "Berlin",
        "country": "DE",
        "postcode": "45678",
        "state": "BE"
      },
      "birth_city": "Berlin",
      "birth_country": "DE",
      "birth_date": "1970-10-01",
      "birth_name": "Schmidt",
      "created_at": "2021-07-21T14:10:00.00Z",
      "first_name": "John",
      "id": "287673ef-1bae-4d8a-9e78-8ddaae249d72",
      "last_name": "Doe",
      "nationalities": [
        "DE",
        "AU"
      ],
      "postal_address": null,
      "salutation": "SALUTATION_MALE",
      "status": "ACTIVE",
      "title": "PROF_DR",
      "updated_at": "2021-07-21T14:10:00.00Z"
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}
{
  "data": [
    {
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "city": "Berlin",
        "country": "DE",
        "postcode": "45678",
        "state": "BE"
      },
      "birth_city": "Berlin",
      "birth_country": "DE",
      "birth_date": "1972-09-30",
      "birth_name": "Schmidt",
      "created_at": "2021-07-21T14:10:00.00Z",
      "data_privacy_and_sharing_agreement": {
        "confirmed_at": "2020-08-24T14:16:22Z",
        "consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
      },
      "email": "karl.schmidt@example.com",
      "fatca": {
        "confirmed_at": "2020-08-24T14:15:22Z",
        "status": false
      },
      "first_name": "Karl",
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "last_name": "Schmidt",
      "nationalities": [
        "DE",
        "AU"
      ],
      "phone_number": "4930901820",
      "postal_address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "city": "Berlin",
        "country": "DE",
        "postcode": "45678",
        "state": "BE"
      },
      "salutation": "SALUTATION_MALE",
      "status": "ACTIVE",
      "terms_and_conditions": {
        "confirmed_at": "2020-08-24T14:14:22Z",
        "consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
      },
      "title": "DR",
      "updated_at": "2021-07-21T14:10:00.00Z"
    },
    {
      "address": {
        "address_line1": "Rosenweg 221",
        "address_line2": "apt. 33",
        "city": "Berlin",
        "country": "DE",
        "postcode": "45678",
        "state": "BE"
      },
      "birth_city": "Berlin",
      "birth_country": "DE",
      "birth_date": "1972-09-30",
      "birth_name": "Schmidt",
      "created_at": "2021-07-21T14:10:00.00Z",
      "data_privacy_and_sharing_agreement": {
        "confirmed_at": "2020-08-24T14:16:22Z",
        "consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
      },
      "email": "karl.schmidt@example.com",
      "fatca": {
        "confirmed_at": "2020-08-24T14:15:22Z",
        "status": false
      },
      "first_name": "Karl",
      "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
      "last_name": "Schmidt",
      "nationalities": [
        "DE",
        "AU"
      ],
      "phone_number": "4930901820",
      "postal_address": null,
      "salutation": "SALUTATION_MALE",
      "status": "ACTIVE",
      "terms_and_conditions": {
        "confirmed_at": "2020-08-24T14:14:22Z",
        "consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
      },
      "title": "DR",
      "updated_at": "2021-07-21T14:10:00.00Z"
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}
{
  "data": [],
  "meta": {
    "count": 0,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 0
  }
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Create a user

post /users

Creates a user.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

users:admin

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
  • 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
  • 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
  • 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
  • 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

required

Idempotency key to prevent the same request from replaying. https://datatracker.ietf.org/doc/id/draft-ietf-httpapi-idempotency-key-header-01.html

Example
"f1150421-2e34-42b6-aae9-52ef157065b9"

application/json

User (BYOL) - Create - Request

object (User (BYOL) - Create - Request)

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

User (TOL) - Create - Request

object (User (TOL) - Create - Request)

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

email

string

email

required

Email of the user. Must be a valid email address.

Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

required

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

phone_number

string

^([0-9]{8,15})?$

Phone number of the user. Phone number E.164 format.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

fatca

object (fatca)

required

status

boolean

required

The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

terms_and_conditions

object (terms_and_conditions)

required

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the terms & conditions. RFC 3339-5, ISO8601 UTC

data_privacy_and_sharing_agreement

object (data_privacy_and_sharing_agreement)

required

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the data sharing agreement. RFC 3339-5, ISO8601 UTC

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

User - Create - Request

Any Of

User (BYOL)

object (User (BYOL))

id

string

uuid

required

User 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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

User (TOL)

object (User (TOL))

id

string

uuid

required

User 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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

email

string

email

Email of the user. Must be a valid email address.

Max Length
100

phone_number

string

^([0-9]{8,15})?$

Phone number of the user. Phone number E.164 format.

fatca

object (fatca)

status

boolean

required

The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

terms_and_conditions

object (terms_and_conditions)

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the terms & conditions. RFC 3339-5, ISO8601 UTC

data_privacy_and_sharing_agreement

object (data_privacy_and_sharing_agreement)

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the data sharing agreement. RFC 3339-5, ISO8601 UTC

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Request Examples

{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-09-30",
  "birth_name": "Schmidt",
  "first_name": "Karl",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "title": "DR"
}
{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-09-30",
  "birth_name": "Schmidt",
  "data_privacy_and_sharing_agreement": {
    "confirmed_at": "2020-08-24T14:16:22Z",
    "consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
  },
  "email": "karl.schmidt@example.com",
  "fatca": {
    "confirmed_at": "2020-08-24T14:15:22Z",
    "status": false
  },
  "first_name": "Karl",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "phone_number": "4930901820",
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "terms_and_conditions": {
    "confirmed_at": "2020-08-24T14:14:22Z",
    "consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
  },
  "title": "DR"
}

Response Examples

{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-09-30",
  "birth_name": "Schmidt",
  "created_at": "2021-07-21T14:10:00.00Z",
  "first_name": "Karl",
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "status": "ACTIVE",
  "title": "DR",
  "updated_at": "2021-07-21T14:10:00.00Z"
}
{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-09-30",
  "birth_name": "Schmidt",
  "created_at": "2021-07-21T14:10:00.00Z",
  "data_privacy_and_sharing_agreement": {
    "confirmed_at": "2020-08-24T14:16:22Z",
    "consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
  },
  "email": "karl.schmidt@example.com",
  "fatca": {
    "confirmed_at": "2020-08-24T14:15:22Z",
    "status": false
  },
  "first_name": "Karl",
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "phone_number": "4930901820",
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "status": "ACTIVE",
  "terms_and_conditions": {
    "confirmed_at": "2020-08-24T14:14:22Z",
    "consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
  },
  "title": "DR",
  "updated_at": "2021-07-21T14:10:00.00Z"
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Get a user by ID

get /users/{user_id}

Returns the user specified by ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

users:readusers:admin

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
  • 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
  • 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
  • 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
  • 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

user_id

string

uuid

required

User unique identifier.

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

User - Get - Response

Any Of

User (BYOL)

object (User (BYOL))

id

string

uuid

required

User 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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

User (TOL)

object (User (TOL))

id

string

uuid

required

User 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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

email

string

email

Email of the user. Must be a valid email address.

Max Length
100

phone_number

string

^([0-9]{8,15})?$

Phone number of the user. Phone number E.164 format.

fatca

object (fatca)

status

boolean

required

The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

terms_and_conditions

object (terms_and_conditions)

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the terms & conditions. RFC 3339-5, ISO8601 UTC

data_privacy_and_sharing_agreement

object (data_privacy_and_sharing_agreement)

consent_document_id

string

uuid

required

Consent unique identifier.

confirmed_at

string

date-time

required

Timestamp at which the user consented to the data sharing agreement. RFC 3339-5, ISO8601 UTC

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-09-30",
  "birth_name": "Schmidt",
  "created_at": "2021-07-21T14:10:00.00Z",
  "first_name": "Karl",
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "status": "ACTIVE",
  "title": "DR",
  "updated_at": "2021-07-21T14:10:00.00Z"
}
{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-09-30",
  "birth_name": "Schmidt",
  "created_at": "2021-07-21T14:10:00.00Z",
  "data_privacy_and_sharing_agreement": {
    "confirmed_at": "2020-08-24T14:16:22Z",
    "consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc"
  },
  "email": "karl.schmidt@example.com",
  "fatca": {
    "confirmed_at": "2020-08-24T14:15:22Z",
    "status": false
  },
  "first_name": "Karl",
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "phone_number": "4930901820",
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "status": "ACTIVE",
  "terms_and_conditions": {
    "confirmed_at": "2020-08-24T14:14:22Z",
    "consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608"
  },
  "title": "DR",
  "updated_at": "2021-07-21T14:10:00.00Z"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Offboard a user

delete /users/{user_id}

Starts the user offboarding process in the background.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

users:admin

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
  • 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
  • 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
  • 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
  • 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

user_id

string

uuid

required

User unique identifier.

Responses

Response Headers

upvest-request-id

string

uuid

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

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Change user data

post /users/{user_id}/data_change_requests

Requests a data change for a user specified by ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

users:admin

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
  • 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
  • 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
  • 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
  • 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

user_id

string

uuid

required

User unique identifier.

application/json

User (BYOL) - Data Change Request

object (User (BYOL) - Data Change Request)

first_name

string

First name of the user.

Min Length
2
Max Length
100

last_name

string

Last name of the user.

Min Length
2
Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

birth_date

string

date

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_name

string

If applicable, birth name of the user.

Max Length
100

nationalities

array[string]

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

address

object (address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

User (TOL) - Data Change Request

One Of

Name change

object (Name change)

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

issuance_date

string

date

required

Issuance date in YYYY-MM-DD format. RFC 3339, section 5.6

data_download_link

string

url

required

Download link for the document that proofs data change.

Max Length
1000

document_type

string

required

The type of document used to proof data change

  • PASSPORT - Passport
  • ID_CARD - National Identification document
Enum
  • PASSPORT
  • ID_CARD

Other

object (Other)

email

string

email

Email of the user. Must be a valid email address.

Max Length
100

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

phone_number

string

^([0-9]{8,15})?$

Phone number of the user. Phone number E.164 format.

birth_name

string

If applicable, birth name of the user.

Max Length
100

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

null

null

Nationality

object (Nationality)

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

issuance_date

string

date

required

Issuance date in YYYY-MM-DD format. RFC 3339, section 5.6

data_download_link

string

url

required

Download link for the document that proofs data change.

Max Length
1000

document_type

string

required

The type of document used to proof data change

  • PASSPORT - Passport
  • ID_CARD - National Identification document
Enum
  • PASSPORT
  • ID_CARD

Address

object (Address)

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

city

string

required

Min Length
1
Max Length
85

issuance_date

string

date

required

Issuance date in YYYY-MM-DD format. RFC 3339, section 5.6

data_download_link

string

url

required

Download link for the document that proofs data change.

Max Length
1000

document_type

string

required

The type of document used to proof data change

  • UTILITY_BILL - Utility bill
  • TELEPHONE_BILL - Telephone bill
  • INTERNET_BILL - Internet bill
  • BANK_STATEMENT - Bank statement
  • REGISTRATION_CERT - Registration certificate
  • RESIDENCE_PERMIT - Residence permit
  • ID_CARD - National Identification document
Enum
  • UTILITY_BILL
  • TELEPHONE_BILL
  • INTERNET_BILL
  • BANK_STATEMENT
  • REGISTRATION_CERT
  • RESIDENCE_PERMIT
  • ID_CARD

Responses

Response Headers

upvest-request-id

string

uuid

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

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Request Examples

{
  "data_download_link": "https://bucket.customer.com/ident/user3.zip",
  "document_type": "ID_CARD",
  "first_name": "Karl",
  "issuance_date": "2030-01-01",
  "last_name": "Schmidt"
}
{
  "email": "max@example.com"
}
{
  "data_download_link": "https://bucket.customer.com/ident/user3.zip",
  "document_type": "ID_CARD",
  "issuance_date": "2030-01-01",
  "nationalities": [
    "DE"
  ]
}
{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "data_download_link": "https://bucket.customer.com/por/user3.zip",
  "document_type": "UTILITY_BILL",
  "issuance_date": "2020-01-01"
}
{
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_date": "1972-01-30",
  "birth_name": "Schmidt",
  "first_name": "Karl",
  "last_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "city": "Berlin",
    "country": "DE",
    "postcode": "45678",
    "state": "BE"
  },
  "salutation": "SALUTATION_MALE",
  "title": "PROF_DR"
}

Response Examples

{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Get user account groups

get /users/{user_id}/account_groups

Lists the account groups of a user specified by ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

accounts:readaccounts:admin

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
  • 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
  • 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
  • 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
  • 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

user_id

string

uuid

required

User unique identifier.

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

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Account Group)]

required

Account Group

object (Account Group)

id

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

id

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

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "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
  }
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Get user accounts

get /users/{user_id}/accounts

Lists the accounts of a user soecified by ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

accounts:readaccounts:admin

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
  • 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
  • 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
  • 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
  • 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

user_id

string

uuid

required

User unique identifier.

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

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Account)]

required

Account

object (Account)

id

string

uuid

required

Account 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

account_group_id

string

uuid

required

Account group unique identifier.

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

users

array[object]

required

object

id

string

uuid

User unique identifier.

type

string

Relation type

  • OWNER -
Default
"OWNER"
Enum
  • OWNER

account_number

int

required

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

Min
1

name

string

required

The name of the account.

Max Length
100

status

string

required

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

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "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
  }
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Users events

webhook

Users events

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

One Of

required

Any Of

User (BYOL)

object (User (BYOL))

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

city

string

required

Min Length
1
Max Length
85

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_name

string

If applicable, birth name of the user.

Max Length
100

created_at

string

date-time

required

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

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

id

string

uuid

required

User unique identifier.

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

city

string

required

Min Length
1
Max Length
85

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

null

null

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

updated_at

string

date-time

required

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

User (TOL)

object (User (TOL))

address

object (address)

required

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

city

string

required

Min Length
1
Max Length
85

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

birth_city

string

Min Length
1
Max Length
85

birth_country

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

birth_date

string

date

required

Birth date of the user in YYYY-MM-DD format. RFC 3339, section 5.6

birth_name

string

If applicable, birth name of the user.

Max Length
100

created_at

string

date-time

required

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

data_privacy_and_sharing_agreement

object (data_privacy_and_sharing_agreement)

confirmed_at

string

date-time

required

Timestamp at which the user consented to the data sharing agreement. RFC 3339-5, ISO8601 UTC

consent_document_id

string

uuid

required

Consent unique identifier.

email

string

email

Email of the user. Must be a valid email address.

Max Length
100

fatca

object (fatca)

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

status

boolean

required

The user’s FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

first_name

string

required

First name of the user.

Min Length
2
Max Length
100

id

string

uuid

required

User unique identifier.

last_name

string

required

Last name of the user.

Min Length
2
Max Length
100

nationalities

array[string]

required

Nationalities of the user. ISO 3166 alpha-2 Codes.

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

phone_number

string

^([0-9]{8,15})?$

Phone number of the user. Phone number E.164 format.

postal_address

One Of

User postal address. Needs to be specified if different to the residential address, otherwise it is automatically populated.

Address

object (Address)

Address

address_line1

string

required

First address line of the address.

Max Length
100

address_line2

string

Second address line of the address.

Max Length
100

city

string

required

Min Length
1
Max Length
85

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

postcode

string

^[a-zA-Z0-9\s\-]{1,10}$

required

Postal code (postcode, PIN or ZIP code)

state

string

State, province, county. ISO 3166 alpha-2 Codes.

Max Length
50

null

null

salutation

string

Salutation of the user used in reports and statements.

  • (empty string) -
  • SALUTATION_MALE -
  • SALUTATION_FEMALE -
  • SALUTATION_FEMALE_MARRIED -
  • SALUTATION_DIVERSE -
Default
""
Enum
  • SALUTATION_MALE
  • SALUTATION_FEMALE
  • SALUTATION_FEMALE_MARRIED
  • SALUTATION_DIVERSE

status

string

required

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum
  • ACTIVE
  • INACTIVE
  • OFFBOARDING
  • OFFBOARDED

terms_and_conditions

object (terms_and_conditions)

confirmed_at

string

date-time

required

Timestamp at which the user consented to the terms & conditions. RFC 3339-5, ISO8601 UTC

consent_document_id

string

uuid

required

Consent unique identifier.

title

string

Title of the user used in reports and statements.

  • (empty string) -
  • DR - Doctor
  • PROF - Professor
  • PROF_DR -
  • DIPL_ING - Graduate engineer (Diplom-Ingenieur)
  • MAGISTER -
Default
""
Enum
  • DR
  • PROF
  • PROF_DR
  • DIPL_ING
  • MAGISTER

updated_at

string

date-time

required

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

Webhook - Users - Callback

object (Webhook - Users - Callback)

reason

string

required

The reason why the data change failed.

Max Length
100

user_id

string

uuid

required

Event unique identifier

type

string

required

Event type

Enum
  • USER.CREATED
  • USER.ACTIVATED
  • USER.DEACTIVATED
  • USER.DATA_CHANGED
  • USER.DATA_CHANGE_FAILED
  • USER.OFFBOARDING_INITIATED
  • USER.OFFBOARDED

webhook_id

string

uuid

required

Webhook unique identifier.

Responses

Request Examples

{
  "created_at": "2021-11-19T13:06:51.980159529Z",
  "id": "2df83681-6a42-4837-a554-a8197335bcfa",
  "object": {
    "address": {
      "address_line1": "Torstrasse",
      "address_line2": "12a",
      "city": "Berlin",
      "country": "DE",
      "postcode": "10115",
      "state": "BE"
    },
    "birth_city": "Berlin",
    "birth_country": "DE",
    "birth_date": "1990-01-01",
    "birth_name": "Smith",
    "created_at": "2021-11-22T09:04:42Z",
    "first_name": "Jane",
    "id": "a1752f00-93d5-4b77-a148-959cd315581b",
    "last_name": "Doe",
    "nationalities": [
      "DE",
      "CH"
    ],
    "postal_address": {
      "address_line1": "Thorstrasse",
      "address_line2": "123",
      "city": "Berlin",
      "country": "DE",
      "postcode": "10115",
      "state": "BE"
    },
    "salutation": "SALUTATION_FEMALE",
    "status": "ACTIVE",
    "title": "PROF",
    "updated_at": "2021-11-22T09:04:42Z"
  },
  "type": "USER.CREATED",
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}
{
  "created_at": "2021-11-22T09:04:42Z",
  "id": "2df83681-6a42-4837-a554-a8197335bcfa",
  "object": {
    "address": {
      "address_line1": "Torstrasse",
      "address_line2": "12a",
      "city": "Berlin",
      "country": "DE",
      "postcode": "10115",
      "state": "BE"
    },
    "birth_city": "Berlin",
    "birth_country": "DE",
    "birth_date": "1990-01-01",
    "birth_name": "Smith",
    "created_at": "2021-11-22T09:04:42Z",
    "data_privacy_and_sharing_agreement": {
      "confirmed_at": "2021-02-03T17:14:46Z",
      "consent_document_id": "dd42b6a9-d04d-4dd2-8c3b-36386eaa843a"
    },
    "email": "janedoe@example.com",
    "fatca": {
      "confirmed_at": "2020-02-03T17:14:46Z",
      "status": false
    },
    "first_name": "Jane",
    "id": "a1752f00-93d5-4b77-a148-959cd315581b",
    "last_name": "Doe",
    "nationalities": [
      "DE",
      "CH"
    ],
    "phone_number": "0123456789",
    "postal_address": {
      "address_line1": "Thorstrasse",
      "address_line2": "123",
      "city": "Berlin",
      "country": "DE",
      "postcode": "10115",
      "state": "BE"
    },
    "salutation": "SALUTATION_FEMALE",
    "status": "ACTIVE",
    "terms_and_conditions": {
      "confirmed_at": "2020-02-03T17:14:46Z",
      "consent_document_id": "62814307-f14b-40af-bc66-5942a549a759"
    },
    "title": "PROF",
    "updated_at": "2021-11-22T09:04:42Z"
  },
  "type": "USER.CREATED",
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}

Was this page helpful?