Users
Download SpecAll user related paths.
sort
string
Sort the result by created_at, updated_at.
- Default
- "created_at"
- Enum
-
- created_at
- updated_at
order
string
Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.
- Default
- "ASC"
- Enum
-
- ASC
- DESC
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
oauth-client-credentials
Required Scopes:
users:readusers:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
Response
OK
{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 1,
"sort": "created_at",
"order": "ASC"
},
"data": [
{
"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"
},
{
"id": "287673ef-1bae-4d8a-9e78-8ddaae249d72",
"created_at": "2021-07-21T14:10:00.00Z",
"updated_at": "2021-07-21T14:10:00.00Z",
"first_name": "John",
"last_name": "Doe",
"salutation": "SALUTATION_MALE",
"title": "PROF_DR",
"birth_date": "1970-10-01",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"postal_address": null,
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"postcode": "45678",
"city": "Berlin",
"state": "BE",
"country": "DE"
},
"status": "ACTIVE"
}
]
}{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 1,
"sort": "created_at",
"order": "ASC"
},
"data": [
{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE"
},
{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": null,
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"postcode": "45678",
"city": "Berlin",
"state": "BE",
"country": "DE"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE"
}
]
}{
"meta": {
"offset": 0,
"limit": 100,
"count": 2,
"total_count": 2,
"sort": "created_at",
"order": "ASC"
},
"data": [
{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE",
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
},
{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"postal_address": null,
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"postcode": "45678",
"city": "Berlin",
"state": "BE",
"country": "DE"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE",
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
}
]
}{
"meta": {
"offset": 0,
"limit": 100,
"count": 0,
"total_count": 0,
"sort": "created_at",
"order": "ASC"
},
"data": []
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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
string
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
branch_id
string
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
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.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
User - Create - Request
Any Of
- Content Type
- application/json
User (BYOL) - Create - Request
object (User (BYOL) - Create - Request)
first_name
string
required
First name(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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(s) of the user. Please include all first and middle names of the user.
- Min Length
- 2
- Max Length
- 100
last_name
string
required
Last name of the user.
- Min Length
- 2
- Max Length
- 100
string
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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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
branch_id
string
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
oauth-client-credentials
Required Scopes:
users:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
idempotency-key
string
uuid
^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$
required
A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency
- Example
- "ccb07f42-4104-44ad-8e1f-c660bb7b269c"
Request
{
"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"
}
}{
"first_name": "Karl",
"last_name": "Schmidt",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
}
}{
"first_name": "Karl",
"last_name": "Schmidt",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
}Response
User created.
{
"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"
}{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE"
}{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE",
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
User - Create - Request
Any Of
- Content Type
- application/json
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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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
string
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
branch_id
string
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
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
user_id
string
uuid
required
User unique identifier.
oauth-client-credentials
Required Scopes:
users:readusers:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
Response
OK
{
"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"
}{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE"
}{
"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",
"email": "karl.schmidt@example.com",
"salutation": "SALUTATION_MALE",
"title": "DR",
"birth_date": "1972-09-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"phone_number": "4930901820",
"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"
},
"fatca": {
"status": false,
"confirmed_at": "2020-08-24T14:15:22Z"
},
"terms_and_conditions": {
"consent_document_id": "a8a87268-4f3c-4de2-abb9-a553a3bb7608",
"confirmed_at": "2020-08-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fb1827c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2020-08-24T14:16:22Z"
},
"status": "ACTIVE",
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
User - Get - Response
Any Of
- Content Type
- application/json
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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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
string
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
branch_id
string
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
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
user_id
string
uuid
required
User unique identifier.
oauth-client-credentials
Required Scopes:
users:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^Bearer [a-zA-Z0-9\-\._~+/]*=*
required
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
- Example
- "Bearer c2VjcmV0Cg=="
signature
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
signature-input
string
required
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
upvest-api-version
string
Upvest API version (Note: Do not include quotation marks)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
Response
The request has been successfully accepted and will be processed asynchronously.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Change user data
Requests a data change for a user specified by ID.
User - Data Change - Request
Any Of
- Content Type
- 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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(s) of the user. Please include all first and middle names 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 URL for the document proving the data change. The file size must not exceed 250 MB.
- Max Length
- 1000
document_type
string
required
The type of document used to prove the data change
- PASSPORT - Passport
- ID_CARD - National Identification document
- Enum
-
- PASSPORT
- ID_CARD
Other
object (Other)
string
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. Must not be a P.O. box or c/o 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
branch_id
string
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
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 URL for the document proving the data change. The file size must not exceed 250 MB.
- Max Length
- 1000
document_type
string
required
The type of document used to prove the data change
- PASSPORT - Passport
- ID_CARD - National Identification document
- Enum
-
- PASSPORT
- ID_CARD
Address
object (Address)
address
object (address)
required
Address. Must not be a P.O. box or c/o 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 URL for the document proving the data change. The file size must not exceed 250 MB.
- 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
oauth-client-credentials
Required Scopes:
users:admin All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
accounts:admin· Create/update/delete accounts and account groups -
accounts:read· Read accounts and account groups -
checks:admin· Create checks -
checks:read· Read checks -
credit_fundings:read· Credit Fundings read operations -
fees:admin· Create and read fee operations -
fees:read· Read fee operations -
files:read· Read files metadata -
instruments:read· Read instruments -
mandates:admin· Create/update/delete mandates -
mandates:read· Read mandates -
orders:admin· Create/update/delete orders -
orders:read· Read orders -
payments:admin· Payins and withdrawal operations -
payments:read· Payins and withdrawal read operations -
portfolios:admin· Modify portfolios -
portfolios:read· Read portfolios -
positions:read· Read positions -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
user_id
string
uuid
required
User unique identifier.
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"
Request
{
"first_name": "Karl",
"last_name": "Schmidt",
"issuance_date": "2030-01-01",
"data_download_link": "https://bucket.customer.com/ident/user3.zip",
"document_type": "ID_CARD"
}{
"email": "max@example.com"
}{
"nationalities": [
"DE"
],
"issuance_date": "2030-01-01",
"data_download_link": "https://bucket.customer.com/ident/user3.zip",
"document_type": "ID_CARD"
}{
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"postcode": "45678",
"city": "Berlin",
"state": "BE",
"country": "DE"
},
"issuance_date": "2020-01-01",
"data_download_link": "https://bucket.customer.com/por/user3.zip",
"document_type": "UTILITY_BILL"
}{
"first_name": "Karl",
"last_name": "Schmidt",
"salutation": "SALUTATION_MALE",
"title": "PROF_DR",
"birth_date": "1972-01-30",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Schmidt",
"nationalities": [
"DE",
"AU"
],
"address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"postcode": "45678",
"city": "Berlin",
"state": "BE",
"country": "DE"
},
"postal_address": {
"address_line1": "Rosenweg 221",
"address_line2": "apt. 33",
"postcode": "45678",
"city": "Berlin",
"state": "BE",
"country": "DE"
}
}{
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
}Response
The request has been successfully accepted and will be processed asynchronously.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
required
Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.
title
string
A short, human-readable title for the general error type; the title should not change for given types.
detail
string
A human-readable description of the specific error.
instance
string
This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.
request_id
string
Correlation ID for the original request.
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
Event unique identifier
created_at
string
date-time
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
- Enum
-
- USER.CREATED
- USER.ACTIVATED
- USER.DEACTIVATED
- USER.DATA_CHANGED
- USER.DATA_CHANGE_FAILED
- USER.OFFBOARDING_INITIATED
- USER.OFFBOARDED
object
One Of
required
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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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(s) of the user. Please include all first and middle names 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. Must not be a P.O. box or c/o 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. Must not be a P.O. box or c/o 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
string
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
branch_id
string
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
Webhook - Users - Callback
object (Webhook - Users - Callback)
user_id
string
uuid
required
Event unique identifier
reason
string
required
The reason why the data change failed.
- Max Length
- 100
webhook_id
string
uuid
required
Webhook unique identifier.
Request
{
"id": "2df83681-6a42-4837-a554-a8197335bcfa",
"created_at": "2021-11-19T13:06:51.980159529Z",
"type": "USER.CREATED",
"object": {
"created_at": "2021-11-22T09:04:42Z",
"updated_at": "2021-11-22T09:04:42Z",
"first_name": "Jane",
"last_name": "Doe",
"salutation": "SALUTATION_FEMALE",
"title": "PROF",
"birth_date": "1990-01-01",
"birth_city": "Berlin",
"birth_country": "DE",
"birth_name": "Smith",
"nationalities": [
"DE",
"CH"
],
"address": {
"address_line1": "Torstrasse",
"address_line2": "12a",
"city": "Berlin",
"country": "DE",
"postcode": "10115",
"state": "BE"
},
"id": "a1752f00-93d5-4b77-a148-959cd315581b",
"postal_address": {
"address_line1": "Thorstrasse",
"address_line2": "123",
"city": "Berlin",
"country": "DE",
"postcode"