Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Auth

Create Authentication Token

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

post/auth

Request body

usernamestring required

The B2B (business to business) back office username.

passwordstring required

The B2B (business to business) back office password.

appTypeIDnumber required

The version type identifier.

Example request

{
  "username": "bo.sample.api",
  "password": "188ff5b0-8f13-4676-8bb2-305b9e08a3ba",
  "appTypeID": 4
}

Response

Creating Authentication Token was successful.

usernamestring

The B2B (business to business) back office username.

authTokenstring

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

expiresAtstring

The date and time the session token expires.

userIDstring

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

firstNamestring

The Firm Name.

lastNamestring

The Firm Type.

parentIBIDstring

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

Example response

{
  "username": "bo.sample.api",
  "authToken": "acb33c99-3a6f-4494-85bf-8dae70977552.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": "4380ee75-5acd-f5af-4347-04146bb3f61a"
  },
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "firstName": "Tendies Trading Company",
  "lastName": "LLC",
  "parentIBID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932"
}