Update an existing user

The endpoint allows to update the details for existing users based on user ID.

Updating the Verification Details
Verification details are stored as a single verification object. We do not store the preceding data, so in the case of updating existing data, we can only overwrite it. It is impossible to change a single detail of verification data, like birth date or nationality; if the update of verification data is needed, the whole verification object needs to be sent again.

SecuritybearerAuth
Request
path Parameters
User-ID
required
string <uuid>

User ID

Request Body schema: application/json

The user to create.

email
string

User email

phone
string

Phone number in E.164 standard format

first_name
string

Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space

last_name
string

Allowed characters: uppercase/lowercase letters, comma, full stop, hyphen, apostrophe, and space

language
string

ISO 639-1 language code for user account

country
string

Alpha-2 ISO 3166 country code. Represents user's citizenship.

terms
Array of integers

The IDs of the accepted terms and conditions and privacy policy

Array of objects
Array of objects

Appropriateness test answers shall be provided latest before the first trade with stocks or ETFs

object
object
object

Compliance information, provided by the Partner

account_level_id
string

User account level ID

external_id
string

User’s identifier at the partner side. Case insensitive

object

Set of key-value pairs, allowing Partner to provide additional information, as agreed during the integration process

Responses
200

Update user

400

Error

401

Invalid user

403

Account is inactive

404

Invalid language

409

Duplicate external_id

422

Error

429

Too Many Requests

500

Error

503

Maintenance or Service unavailable

patch/v2/users/{User-ID}
Request samples
application/json
{
  • "email": "username@domain.com",
  • "phone": "+33123123412",
  • "first_name": "Jean",
  • "last_name": "Pascal",
  • "language": "en",
  • "country": "FR",
  • "terms": [
    ],
  • "aml": [
    ],
  • "appropriateness": [
    ],
  • "verification": {
    },
  • "tax": {
    },
  • "ext_compliance": {
    },
  • "account_level_id": "1",
  • "external_id": "Ext-Id-1",
  • "external_meta": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}