Skip to content
API Reference/
/
Get a user by ID

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

Create a user

Request

Creates a user.

Security
oauth-client-credentials
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

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

signature-inputstringrequired

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

idempotency-keystring(uuid)^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-f...required

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

Example: ccb07f42-4104-44ad-8e1f-c660bb7b269c
upvest-api-versionstring

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

Default 1
Value"1"
Example: 1
Bodyapplication/json
Any of:
first_namestring[ 2 .. 100 ] charactersrequired

First name(s) of the user. Please include all first and middle names of the user.

last_namestring[ 1 .. 100 ] charactersrequired

Last name of the user.

birth_datestring(date)required

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

nationalitiesArray of stringsnon-emptyrequired

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

Items Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
addressobjectrequired

Address. Must not be a P.O. box or c/o address.

address_line1string<= 100 charactersrequired

First address line of the address.

postcodestring^[a-zA-Z0-9][a-zA-Z0-9\s\-]{0,8}[a-zA-Z0-9]?$...required

Postal code (postcode, PIN or ZIP code)

countrystringrequired

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
citystring[ 1 .. 85 ] charactersrequired
address_line2string<= 100 characters

Second address line of the address.

statestring<= 50 characters

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

salutationstring

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"
titlestring

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_citystring[ 1 .. 85 ] characters
birth_countrystring

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
birth_namestring<= 100 characters

If applicable, birth name of the user.

postal_addressobject or null
One of:

Address. Must not be a P.O. box or c/o address.

branch_idstring(uuid)

Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly

curl -i -X POST \
  https://sandbox.upvest.co/users \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
  -d '{
    "first_name": "Karl",
    "last_name": "Schmidt",
    "salutation": "SALUTATION_MALE",
    "title": "DR",
    "birth_date": "1972-09-30",
    "birth_city": "Berlin",
    "birth_country": "DE",
    "birth_name": "Schmidt",
    "nationalities": [
      "DE",
      "AU"
    ],
    "postal_address": {
      "address_line1": "Rosenweg 221",
      "address_line2": "apt. 33",
      "postcode": "45678",
      "city": "Berlin",
      "state": "BE",
      "country": "DE"
    },
    "address": {
      "address_line1": "Rosenweg 221",
      "address_line2": "apt. 33",
      "postcode": "45678",
      "city": "Berlin",
      "state": "BE",
      "country": "DE"
    }
  }'

Responses

User created.

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

User unique identifier.

created_atstring(date-time)required

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

updated_atstring(date-time)required

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

first_namestring[ 2 .. 100 ] charactersrequired

First name(s) of the user. Please include all first and middle names of the user.

last_namestring[ 1 .. 100 ] charactersrequired

Last name of the user.

birth_datestring(date)required

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

nationalitiesArray of stringsnon-emptyrequired

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

Items Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
addressobjectrequired

Address. Must not be a P.O. box or c/o address.

address_line1string<= 100 charactersrequired

First address line of the address.

postcodestring^[a-zA-Z0-9][a-zA-Z0-9\s\-]{0,8}[a-zA-Z0-9]?$...required

Postal code (postcode, PIN or ZIP code)

countrystringrequired

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
citystring[ 1 .. 85 ] charactersrequired
address_line2string<= 100 characters

Second address line of the address.

statestring<= 50 characters

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

statusstringrequired

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum"ACTIVE""INACTIVE""OFFBOARDING""OFFBOARDED"
salutationstring

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"
titlestring

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_citystring[ 1 .. 85 ] characters
birth_countrystring

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
birth_namestring<= 100 characters

If applicable, birth name of the user.

postal_addressobject or null
One of:

Address. Must not be a P.O. box or c/o address.

branch_idstring(uuid)

Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly

Response
application/json
{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "first_name": "Karl",
  "last_name": "Schmidt",
  "salutation": "SALUTATION_MALE",
  "title": "DR",
  "birth_date": "1972-09-30",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "status": "ACTIVE"
}

Get a user by ID

Request

Returns the user specified by ID.

Security
oauth-client-credentials
Path
user_idstring(uuid)required

User unique identifier.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

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

signature-inputstringrequired

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

upvest-api-versionstring

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

Default 1
Value"1"
Example: 1
curl -i -X GET \
  'https://sandbox.upvest.co/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'

Responses

OK

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

User unique identifier.

created_atstring(date-time)required

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

updated_atstring(date-time)required

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

first_namestring[ 2 .. 100 ] charactersrequired

First name(s) of the user. Please include all first and middle names of the user.

last_namestring[ 1 .. 100 ] charactersrequired

Last name of the user.

birth_datestring(date)required

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

nationalitiesArray of stringsnon-emptyrequired

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

Items Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
addressobjectrequired

Address. Must not be a P.O. box or c/o address.

address_line1string<= 100 charactersrequired

First address line of the address.

postcodestring^[a-zA-Z0-9][a-zA-Z0-9\s\-]{0,8}[a-zA-Z0-9]?$...required

Postal code (postcode, PIN or ZIP code)

countrystringrequired

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
citystring[ 1 .. 85 ] charactersrequired
address_line2string<= 100 characters

Second address line of the address.

statestring<= 50 characters

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

statusstringrequired

Status of the user.

  • ACTIVE -
  • INACTIVE -
  • OFFBOARDING -
  • OFFBOARDED -
Enum"ACTIVE""INACTIVE""OFFBOARDING""OFFBOARDED"
salutationstring

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"
titlestring

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_citystring[ 1 .. 85 ] characters
birth_countrystring

Accepted country code. ISO 3166-1 alpha-2 codes.

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
birth_namestring<= 100 characters

If applicable, birth name of the user.

postal_addressobject or null
One of:

Address. Must not be a P.O. box or c/o address.

branch_idstring(uuid)

Unique identifier of the market the user is onboarded on. Only relevant if the client is operating in different markets and the client is configured accordingly

Response
application/json
{
  "id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "first_name": "Karl",
  "last_name": "Schmidt",
  "salutation": "SALUTATION_MALE",
  "title": "DR",
  "birth_date": "1972-09-30",
  "birth_city": "Berlin",
  "birth_country": "DE",
  "birth_name": "Schmidt",
  "nationalities": [
    "DE",
    "AU"
  ],
  "postal_address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "address": {
    "address_line1": "Rosenweg 221",
    "address_line2": "apt. 33",
    "postcode": "45678",
    "city": "Berlin",
    "state": "BE",
    "country": "DE"
  },
  "status": "ACTIVE"
}

Offboard a user

Request

Starts the user offboarding process in the background.

Security
oauth-client-credentials
Path
user_idstring(uuid)required

User unique identifier.

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

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

signature-inputstringrequired

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

upvest-api-versionstring

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

Default 1
Value"1"
Example: 1
curl -i -X DELETE \
  'https://sandbox.upvest.co/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'

Responses

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

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Response
No content

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations