Create User

Creates a User.

A user on the DriveWealth platform can represent one of the following:

TypeDescription
IndividualAn individual user represents your customer, who is accessing an investment product with their own funds and assets.
Partner

A partner is an organization that interfaces with DriveWealth. DriveWealth provides brokerage services to help firms fulfill the needs of their individual customers.

Each Partner is also represented by a single User entity, and is created by DriveWealth.

Body Params
string
sensitive
string
sensitive
string
enum
required

The type of user being onboarded.

Show Details
INDIVIDUAL_TRADERAn individual retail trader.
CUSTODIALA custodian onboarding an account on behalf of a minor.
BENEFICIARYA beneficiary of another user's account.
Allowed:
string
deprecated

The wlpID is a deep backoffice ID that identifies each partner from each other.

*⚠️ Only require to pass if your existing partner before 10/1/22.

string
deprecated

The parentIBID is a identifier that identifies a partners different business segments.

*⚠️ Only require to pass if your existing partner before 10/1/22.

string

The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile.

*⚠️ This is optional and only users for certain partners are eligible.

documents
array of objects
required

The personal identifiable information & digital signatures.

documents*
metadata
object

sensitive
The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes. Do not put personal or account data in this field.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json