DRdrivewealth
Users

Create User

Creates a User.

post/users

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/users
  • Auth
    HTTP bearer

Request body

usernamestring

sensitive

passwordstring

sensitive

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.

metadataMetadata

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.

Example request

{
  "username": "sampleuser",
  "password": "samplepassword",
  "userType": "INDIVIDUAL_TRADER",
  "wlpID": "TTCC",
  "parentIBID": "123e4567-e89b-12d3-a456-00000000015c",
  "walletSettlementProfileID": "bank-profile-1",
  "documents": [
    {
      "type": "BASIC_INFO",
      "data": {
        "firstName": "John",
        "lastName": "Smith",
        "country": "USA",
        "phone": "18005550100",
        "emailAddress": "john.doe@example.com"
      }
    }
  ],
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Creating a User was Successful.

idstring

sensitive 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": "123e4567-e89b-12d3-a456-000000000004",
  "userType": {
    "name": "INDIVIDUAL_TRADER",
    "description": "Individual Trader"
  },
  "status": {
    "name": "PENDING",
    "description": "User is pending approval."
  },
  "parentIBID": {
    "id": "123e4567-e89b-12d3-a456-000000000005",
    "name": "Tendies Trading Company"
  },
  "documents": [
    {
      "type": "BASIC_INFO",
      "data": {
        "firstName": "John",
        "lastName": "Smith",
        "country": "USA",
        "phone": "18005550100",
        "emailAddress": "john.doe@example.com"
      }
    }
  ],
  "wlpID": "TTC",
  "walletSettlementProfileID": "bank-profile-1",
  "referralCode": "71J000",
  "createdWhen": "2022-12-11T22:28:21.810Z",
  "updatedWhen": "2022-12-11T22:28:21.810Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.