Assigning a branch to a user
Prerequisites
Initially, Upvest must create a branch_id
for you. To do this, contact us - for example, the Upvest Launch Manager - and together we will agree how the branches should be structured according to your requirements.
Once we have created these branches, we will provide the corresponding branch_ids
that you can assign at user level.
Creating a user with a branch
To create a user with a branch, execute the following request:
POST /users
Example request
{
"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"
}
Adding a branch to an existing user
To add the branch_id
to an existing user, make the following call:
POST /users/{user_id}/data_change_requests
Example request
{
"branch_id": "e6373bfa-ff12-4004-8de9-747ac96764da"
}
You can find a detailed guide about users in this guide.