DRdrivewealth
Auth

Create Authentication Token

Creates an authentication token for an implementer to utilize for subsequent API requests.

post/auth

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/auth
  • Auth
    none required

Request body

usernamestring required

sensitive The B2B (business to business) back office username.

passwordstring required

sensitive The B2B (business to business) back office password.

appTypeIDnumber required

The version type identifier.

Example request

{
  "username": "bo.sample.api",
  "password": "123e4567-e89b-12d3-a456-00000000003f",
  "appTypeID": 4
}

Response

Creating Authentication Token was successful.

usernamestring

sensitive The B2B (business to business) back office username.

authTokenstring

sensitive The B2B (business to business) back office session token.

expiresAtstring

The date and time the session token expires.

userIDstring

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

firstNamestring

sensitive The Firm Name.

lastNamestring

sensitive The Firm Type.

parentIBIDstring

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

Example response

{
  "username": "bo.sample.api",
  "authToken": "123e4567-e89b-12d3-a456-00000000003d.2018-07-26T14:45:47.391Z",
  "expiresAt": "2022-12-28T01:09:33.714Z",
  "security": {
    "description": "Partner Principal",
    "permissionSet": [
      "ACCOUNTS_CREATE_LIVE",
      "ACCOUNTS_CREATE_MANAGED",
      "ACCOUNTS_CREATE_MARGIN",
      "ACCOUNTS_CREATE_PRACTICE",
      "ACCOUNTS_CREATE_RIA_MANAGED",
      "ACCOUNTS_EDIT"
    ],
    "permissionID": "123e4567-e89b-12d3-a456-00000000003e"
  },
  "userID": "123e4567-e89b-12d3-a456-000000000004",
  "firstName": "Tendies Trading Company",
  "lastName": "LLC",
  "parentIBID": "123e4567-e89b-12d3-a456-000000000004"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.