Operating Model:
Operating Model:

User offboarding

This guide lines out how you offboard users from the Investment API.

How user offboarding works

Offboarding a user is the last step of removing a user from the Investment API. Before a user can be offboarded, all the user’s accounts and account groups have to be closed. To find out how to close accounts and account groups please take a look at the 'Account closure guide'.

For more context on the status a user can have, see the 'User onboarding guide'.

INFO

You will always be able to retrieve historical information on users that are already offboarded. (At least for the period Upvest is obliged to keep the data after the user offboarding).

Offboarding a user

Prerequisites

Before you can offboard a user you must have created one, find out how to do so in our 'User onboarding guide'.

To offboard a user, send DELETE /users/{user_id} and the user will be moved to an OFFBOARDING status. The user remains in the OFFBOARDING status until there is no open account group and no pending regulatory reports (i.e. annual tax statement). After all requirements have been met, the user status OFFBOARDED is set. To inform you about the final offboarding of the user, you will receive a webhook with the corresponding user offboarded event.

Next steps

As offboarding concludes the last step of a lifecycle on the Investment API, you can start creating new users by taking a look into our 'User onboarding guide'.

Was this page helpful?