User offboarding
Offboarding a user is the final step in removing a user from the Investment API.
You will always be able to retrieve historical information about users who are already offboarded. (At least for the period Upvest is obliged to keep the data after the user has been offboarded).
In this guide you will learn how to offboard users from the Investment API.
Prerequisites
Before you can offboard a user,
- that user must already be onboarded in the Investment API.
- all accounts and account groups of the user must be closed. To find out how to close accounts and account groups please refer to the guide Close accounts and account groups.
Offboarding a user
Initiate the offboarding of a user by sending
DELETE /users/{user_id}
User offboarding status
Offboarding a user is not necessarily instant. You may wish to monitor the process.
| Status | Description |
|---|---|
OFFBOARDING | When you initiate offboarding. The user remains in this status until there are no open account groups and no pending regulatory reporting (e.g., annual tax statements). |
OFFBOARDED | As soon as all requirements are met, the user is set to this status. |
To monitor the status of the users offboarding you can look directly at the user:
GET /users/{user_id}
To inform you of the final offboarding of the user, you will receive a webhook with the corresponding user offboarded event.
Please note that depending on the user's domicile, the time of account closure in connection with user offboarding may vary, e.g. accounts in the United Kingdom are only closed at the end of a tax year.