User data change

A user might request a data change when, for example, moving to a new city or getting married and thus changing their name or adding a nationality.

This guide outlines how to use the Investment API to change user data and the proof documents that must be provided in support of these changes.

Prerequisites

Before you can change data of a user you must have created one. You can find out how to do this in our User onboarding guide.

1 Changing user data

In the request body, you specify which fields you intend to change.

Depending on the respective fields to be changed, Upvest may require a proof for changing the user information. There are four different categories available that require different proof documents.

The following proof documents are accepted:

Category	User fields	Required proof documents
Name change	`first_name` & `last_name`	PASSPORT - PassportID_CARD - National Identification document
Nationality change	`nationalities` (array)	PASSPORT - PassportID_CARD - National Identification document
Address change	`address` (object)	UTILITY_BILL - Utility billTELEPHONE_BILL - Telephone billINTERNET_BILL - Internet billBANK_STATEMENT - Bank statementREGISTRATION_CERT - Registration certificateRESIDENCE_PERMIT - Residence permitID_CARD - National Identification document
Other	`salutation`, `title`, `email`, `phone_number`, `birth_name`, `postal_address`	N/A

1.1 Request a change to user data

Changes to user data are achieved by posting a data_change_request for a specific user id:

POST /users/{user_id}/data_change_requests

Example request

{
  "first_name": "Franz",
  "last_name": "Müller",
  "address": {
    "address_line1": "Rosenweg 222",
    "postcode": "45678",
    "city": "Berlin",¯
    "state": "BE",
    "country": "DE"
  },
}

1.2 Changing the user's name

Changing a users name requires either a passport or national ID card to be uploaded to your data transfer bucket and its URL within that bucket to be included in the request.

Example 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"
}

1.3 Changing the user's address

Changing a users name requires one of the forms of evidence listed above to be uploaded to your data transfer bucket and its URL within that bucket to be included in the request.

Example request

{
  "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"
}

1.4 Changing other user details

Changing other user details, such as the email address, phone number or salutation, doesn't require additional evidence to be provided. This example show a simple request to change a user's email address.

Example request

{
  "email": "max@example.com"
}

After you requested a data change Upvest will download a potential proof for the data change, adjust the user information and then send a data change passed webhook. If the data change failed, e.g. due to problems with the proof files, you will receive a data change failed webhook.

Webhooks notify you of events in business processes, not the success or failure of the initialisation of those processes.

Please be sure to check the HTTP status of the response to your requests and handle failure cases appropriately.

✔ Complete!

Next steps

Since a change to user data can made at any point in the user's lifecycle in the Investment API, a next step could be to create an account group or place an order. You can see the updated data when retrieving a report.