PATCH
/
api
/
users

Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

Authorizations

x-api-key
string
header
required

Body

application/json
individualData
object
invoicing
object
onboarding
object

Response

200 - application/json
attributes
enum<string>[]
Available options:
disabled,
banned,
broker,
brokerCustomer,
summedVolumeFees,
noReissueQuoteAfterExpiration,
prepaidOrders,
hasTransfersEnabled,
noVolatilityError,
brokerFeesEnabled,
canUploadKYCReportFile,
shortQuote,
needsAddressApproval,
canPriceMatch,
doNotSendOrderConfirmationEmail,
doNotSendOnboardingEmails
createdAt
string

Creation date of the user.

email
string

Email of the user.

id
string

ID of the user.

individualData
object
invoicing
object
onboarding
object
phoneNumber
string

Phone number of the user.

type
enum<string>

Type of the user.

Available options:
business,
individual