v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Users

Create User

Creates a User.

post/users

Request body

usernamestring

passwordstring

userType'INDIVIDUAL_TRADER' | 'CUSTODIAL' | 'BENEFICIARY' required

The type of user being onboarded.

wlpIDstring

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.

parentIBIDstring

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

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

walletSettlementProfileIDstring

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

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

metadataobject

The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

Example request

{
  "username": "sampleuser",
  "password": "samplepassword",
  "userType": "INDIVIDUAL_TRADER",
  "wlpID": "TTCC",
  "parentIBID": "95c98ed5-e29e-4d55-90bf-8898fcf6af85",
  "walletSettlementProfileID": "bank-profile-1",
  "documents": [
    {
      "type": "BASIC_INFO",
      "data": {
        "firstName": "Justin",
        "lastName": "Smith",
        "country": "USA",
        "phone": "18004612680",
        "emailAddress": "jj@drivewealth.dev"
      }
    }
  ],
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Creating a User was Successful.

idstring

A unique identifier created for each User on DriveWealth's platform.

wlpIDstring

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

walletSettlementProfileIDstring

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

referralCodestring

The associated referral program associated to the User.

createdWhenstring

The createdWhen is the date and time the User was created.

updatedWhenstring

The updatedWhen is the last date and time the User was updated.

Example response

{
  "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "userType": {
    "name": "INDIVIDUAL_TRADER",
    "description": "Individual Trader"
  },
  "status": {
    "name": "PENDING",
    "description": "User is pending approval."
  },
  "parentIBID": {
    "id": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
    "name": "Tendies Trading Company"
  },
  "documents": [
    {
      "type": "BASIC_INFO",
      "data": {
        "firstName": "Justin",
        "lastName": "Smith",
        "country": "USA",
        "phone": "18004612680",
        "emailAddress": "jj@drivewealth.dev"
      }
    }
  ],
  "wlpID": "TTC",
  "walletSettlementProfileID": "bank-profile-1",
  "referralCode": "71J000",
  "createdWhen": "2022-12-11T22:28:21.810Z",
  "updatedWhen": "2022-12-11T22:28:21.810Z"
}