Diff for /documentation/guides/users/

On this page, you can preview the modified document with the changes.
Note that the links within this diff are most likely broken because they are

  • relative to the original document or

  • point to another document that is not part of the changeset.

Go back to the summary

User onboarding

This guide walks you through all aspects of onboarding a user in the Investment API, including user creation and regulatory identifiers.

How user onboarding works

Onboarding is the starting point of the user's interaction with your product. We designed this process to be as simple as possible to cover all legal, regulatory and compliance aspects in a reasonable way.


You can start onboarding users as soon as you have completed the steps listed in the Getting started guide.

Onboarding a user

Step 1: Creating a user

To onboard a user, follow these steps:

  1. First, collect which have to satisfy the following conditions:
  • It must not be a P.O. box (Post Office box) or c/o (in care of) address. - A user must have at least one nationality. If a user has multiple nationalities, all nationalities need to be submitted.

  1. Send the user's personal information with POST /users.

Status of a user

The following status apply to a user:

INACTIVEThe user's approval is pending - the user is visible via our API but cannot be processed.
ACTIVEUser is active - the full functionality of the Investment API is accessible.
OFFBOARDINGThe offboarding of the user is initiated - the prerequisites are being checked continuously.
OFFBOARDEDUser is offboarded - the user's record can be kept for the regulatory period.

You can list all users with GET /users.

To retrieve a single user call GET /users/{user_id} with the user ID you received after creation.

In order to create regulatory required transaction reports, Upvest must maintain certain identifiers per user. By default, the Investment API supports the onboarding of users for the following nationalities (as a single nationality or, in the case of multiple nationalities, the first nationality if the nationalities array is in alphabetical order):

  • AT - Austria
  • DE - Germany
  • FR - France
  • HU - Hungary
  • IE - Ireland
  • LU - Luxembourg

Any other user nationalities require an additional identifier. You can add the relevant identifier as follows:

POST /users/{user_id}/identifiers

including the identifier type NATIONAL_ID in the payload.

More information on the accepted user identifiers can be found here.

Next steps

After successfully creating a user on the Investment API, you can proceed with opening an account group and an account for the respective user. The accounts will only become active once the user's onboarding has been successfully completed.