Errors

Overview

DriveWealth uses standard HTTP response codes to indicate the success or failure of an API request. Generally codes represent the following:

  • Codes in the 2xx range indicate success
  • Codes in the 4xx range indicate a failure given the information provided
  • Codes in the 5xx range indicate an error with the DriveWealth servers (very uncommon)

In the occurrence of 4xx response code, DriveWealth will provide a JSON error code message that briefly explains the error.

Each API request has an associated request identifier. You can find this value in the response headers, under dw-request-id. You should log this identifier as you would any other API response.

List of error messages

Error

Error Code

Description

ACCOUNT_NO_ERROR

A000

Account No RestError

ACCOUNT_MISSING_PARAMETER

A010

A required parameter is missing or invalid. Refer to the API documentation for details.)

ACCOUNTID_MISSING_INVALID

A011

A required accountID is missing or invalid. Refer to the API documentation for details.)

ACCOUNTNO_MISSING_INVALID

A012

A required accountNo is missing or invalid. Refer to the API documentation for details.)

ACCOUNT_DATERANGE_MISSING_INVALID

A013

A required date range is missing or invalid. Refer to the API documentation for details.)

ACCOUNT_INVALID_USER_TYPE

A015

This type of account cannot be created for the given user.)

ACCOUNT_BAD_COMBINATION_PARAMETER

A020

One or more parameters in the given combination is missing or invalid.)

ACCOUNT_MISSING_USER_PARAMETER

A035

Unable to create account due to missing field(s) on the user.

ACCOUNT_CASH_TRANSFER_INVALID_AMOUNT

A044

The amount of the cash to be transfered is missing or invalid.)

ACCOUNT_TRANSFER_MISSING_COMMENT

A045

The comment of this transfer is missing.)

ACCOUNT_CASH_TRANSFER_INSUFFICIENT_FUNDS

A047

There is insufficient cash in the account to complete transfer)

ACCOUNT_NOT_FOUND

A050

The account you were trying to retrieve was not found.)

ACCOUNT_INVALID_OPERATION

A055

The requested operation cannot be performed on this account.)

ACCOUNT_CASH_TRANSFER_FROM_FAILURE

A062

Transferring the cash from the account is failed.)

ACCOUNT_CASH_TRANSFER_TO_FAILURE

A063

Transferring the cash to the account is failed.)

ACCOUNT_CASH_TRANSFER_OUTSIDE_MMW

A065

Transferring cash outside money movement window is not permitted.)

ACCOUNT_NOT_HOUSE_ACCOUNT

A071

The account is not a house account)

ACCOUNT_INVALID_RIA

A072

The user account does not belong to the given RIA)

ACCOUNT_ERROR

A100

There was an error in retrieving the account.)

ACATS_BAD_SYMBOL_REQUEST

AC001

Acats Request rejected because Symbols are not available.)

ACATS_NO_ERROR

AC000

Acats Request submitted.)

ACATS_INPUT_INVALID

AC002

Input(s) invalid)

ACATS_REQUEST_ALREADY_SUBMITTED

AC003

Request has been already submitted.)

BOD_NOT_FOUND

B050

Unable to generate BOD summary. Contact administrator.)

BENEFICIARIES_ACCOUNT_ERROR

B001

Beneficiaries account request failed.)

COMMISSION_NO_COMMISSION_ID

C010

No commissions set for current BackOffice user. Contact administrator to get a commission schedule.)

DOCUMENT_NO_ERROR

D000

Document No RestError)

DOCUMENT_TOO_LARGE

D001

Document is too large to upload. Please resize your document.)

DOCUMENT_INVALID_CONTENT_TYPE

D011

Content type not accepted.)

DOCUMENT_NOT_FOUND

D050

The document you were trying to retrive was not found.)

DOCUMENT_ERROR

D100

There was an error in retrieving the document.)

DOCUMENT_APPROVED

D200

Document has been Approved.)

DOCUMENT_PENDING

D201

Document approval is Pending.)

DOCUMENT_REJECTED

D202

Document has been Rejected.)

DOCUMENT_NOT_SUBMITTED

D203

Document has not been submitted for approval.)

DOCUMENT_UPLOAD_DENIED

D204

User does not have permission to upload Document. Please check your User Status for more information.)

DOCUMENT_UNKNOWN

D205

unknown)

HEADER_NO_ERROR

H000

Header No RestError)

HEADER_APP_KEY_NOT_FOUND

H050

Client App Key header not found. Contact tech support if you do not have an app key.)

HEADER_APP_KEY_INVALID

H055

Client App Key header invalid. Contact tech support.)

HEADER_AUTH_TOKEN_NOT_FOUND

H060

Auth token header not found. Log in first to obtain an auth token.)

HEADER_AUTH_TOKEN_INVALID

H065

Invalid auth token header. If problem persists, try re-log in.)

HEADER_DW_CUSTOMER_NOT_FOUND

H070

DW custom user ID header not found. This header is required for this operation)

HEADER_DW_CUSTOMER_ACCOUNT_NOT_FOUND

H075

DW custom account ID header not found. This header is required for this operation)

HEADER_BEARER_TOKEN_ALGORITHM_MISSING_INVALID

H080

Algorithm in bearer token is missing/invalid.)

HEADER_BEARER_TOKEN_ISSUER_MISSING_INVALID

H081

Issuer in bearer token is missing/invalid.)

HEADER_BEARER_TOKEN_ENVIRONMENTS_MISSING_INVALID

H082

Allowed environments in bearer token are missing/invalid.)

HEADER_BEARER_TOKEN_WEB_KEY_NOT_FOUND

H085

Unable to retrieve web key from token key ID.)

HEADER_BEARER_TOKEN_INVALID

H090

Bearer token is invalid.)

HEADER_BEARER_TOKEN_ERROR

H100

Bearer token error. Contact tech support.)

INSTRUMENT_INVALID_TRADE_STATUS

I010

Invalid trade status. Refer to the API documentation for details.)

INSTRUMENT_INVALID_EXCHANGE_ID

I011

Invalid exchangeID. Refer to the API documentation for details.)

INSTRUMENT_INVALID_TYPE

I012

Invalid instrument type. Refer to the API documentation for details.)

INSTRUMENT_INVALID_ORDER_SIZE

I013

Invalid order size(min/max/step). Refer to the API documentation for details.)

INSTRUMENT_MISSING_SYMBOL

I014

Symbol is required when updating the instrument image.)

INSTRUMENT_UPDATE_FORBIDDEN

I015

Some fields of an instrument can not be updated. Refer to the API documentation for details.)

INSTRUMENT_GROUP_INVALID_TYPE

I016

Invalid instrument group type. Refer to the API documentation for details.)

INSTRUMENT_GROUP_INVALID_STATUS

I017

Invalid instrument group status. Refer to the API documentation for details.)

INSTRUMENT_GROUP_INVALID_ID

I018

Invalid instrument group ID.)

INSTRUMENT_GROUP_INVALID_SYMBOLS

I019

Invalid symbol(s) in the request body.)

INSTRUMENT_NOT_FOUND

I050

The instrument(s) you were trying to retrieve was not found.)

IDEMPOTENCY_KEY_INVALID_LENGTH

IK010

Idempotency Key too short. Refer to the API documentation for details.)

IDEMPOTENCY_KEY_BAD_TOKEN

IK025

Error in processing idempotency request token. Contact support.)

IDEMPOTENCY_KEY_RESPONSE_ERROR

IK075

Something went wrong in retrieving cached response. Aborting with error response.)

BANK_ACCOUNT_SUCCESS

K000

Bank account no RestError.)

BANK_ACCOUNT_NOT_FOUND

K050

Bank account temporarily disabled or not found. Contact customer support.)

BANK_ACCOUNT_INVALID

K075

Invalid bank account for this operation. Contact customer support if this persists.)

BANK_ACCOUNT_ERROR

K100

Bank account error.)

BANK_ACCOUNT_INVALID_PLAID_TOKEN

K110

Plaid processor token provided is invalid)

LOGIN_SUCCESS

L000

Login Success.)

LOGIN_2FA_MISSING

L010

Missing Two Factor Authentication information.)

LOGIN_2FA_TYPE_SELECTION

L011

Missing or invalid 2FA type selection.)

LOGIN_PHONE_NUMBER_NOT_VALID

L015

Phone number format not recognized. Use email verification or contact customer support.)

LOGIN_MISSING_TEMP_CODE

L019

Missing temp code. Provide a valid temp code issued at log in.)

LOGIN_INVALID_TEMP_CODE

L020

Invalid temp code. Please log in again.)

LOGIN_NULL_TEMP_CODE

L022

Temp code has already been used or was never issued. Please log in again.)

LOGIN_NO_HEARTBEAT

L024

Auth Token expired due to inactivity. Please log in again.)

LOGIN_EXPIRED

L025

Auth Token expired. Please log in Again.)

LOGIN_INVALID

L050

Invalid Credentials.)

LOGIN_INVALID_TOKEN

L065

Invalid auth token. Please log in again.)

LOGIN_2FA_REQUIRED

L070

Two factor authentication required for login. Re-login via 2FA.)

LOGIN_LOGGED_OUT

L075

User already logged out. Please log in again.)

LOGIN_AUTH_FAILURE

L090

Something went wrong in trying to retrieve your auth token. Please log in again.)

LOGIN_FAILURE

L100

Login Failure.)

MANAGED_ACCOUNT_INVALID

M010

The riaID is not valid or not active.)

MANAGED_ACCOUNT_CLIENT_INVALID

M011

The accountID/accountNo does not belong to the master account.)

MANAGED_ACCOUNT_INVALID_CASH_TRANSFER

M012

The riaID is not valid for transfering cash from/to sub account.)

MANAGED_ACCOUNT_INACTIVE_ACCOUNT

M013

The account is NOT active.)

INSTANT_FUNDING_NO_ERROR

N000

Instant funding no error.)

INSTANT_FUNDING_NO_ACCOUNT

N010

Instant funding account not set. Contact administrator.)

INSTANT_FUNDING_EXISTING_ACCOUNT

N015

Instant funding account already exists. Contact administrator.)

INSTANT_FUNDING_ACCOUNT_INACTIVE

N020

Instant funding account is disabled. Contact administrator.)

INSTANT_FUNDING_INVALID_AMOUNT

N030

Invalid amount for deposit.)

INSTANT_FUNDING_NO_FUNDS

N050

Instant funding threshold reached. Contact administrator.)

INSTANT_FUNDING_INSUFFICIENT_FUNDS

N050

Insufficient funds in IFA account. Contact administrator.)

INSTANT_FUNDING_ERROR

N100

There was an error in processing the instant money movement request.)

FUND_INVALID_FUND_TYPE

N060

Invalid fund type. Refer to the API documentation for details.)

ORDER_INVALID_ORDER_TYPE

O005

Invalid order type. Refer to the API documentation for details.)

ORDER_INVALID_ORDER_SIDE

O006

Invalid order side. Refer to the API documentation for details.)

ORDER_INVALID_STOP_REQUEST

O010

Incomplete stop order. One more more parameters may be missing or invalid.Refer to the API documentation for details.)

ORDER_INVALID_LIMIT_REQUEST

O011

Incomplete limit order. One more more parameters may be missing or invalid. Refer to the API documentation for details.)

ORDER_INVALID_MARKET_REQUEST

O012

Invalid market order. One more more parameters may be missing or invalid. Refer to the API documentation for details.)

ORDER_EITHER_QTY_OR_CASH

O015

Invalid order. Enter one from amount OR order quantity. Refer to the API documentation for details.)

ORDER_INVALID_ORDER_METHOD

O016

Invalid order method. Refer to the API documentation for details.)

ORDER_INVALID_MIT_REQUEST

O017

Incomplete marketIftouched order. One more more parameters may be missing or invalid.Refer to the API documentation for details.)

ORDER_INVALID_TIF_REQUEST

O018

Invalid Time In Force. One more more parameters may be missing or invalid.Refer to the API documentation for details.)

ORDER_INVALID_EXPIRATION_REQUEST

O019

Invalid order expiration. One more more parameters may be missing or invalid.Refer to the API documentation for details.)

ORDER_NOT_FOUND

O050

Requested order resource was not found.)

ORDER_ACCOUNT_ERROR

O098

Orders can only be placed on open accounts.)

ORDER_ERROR

O099

There was an error processing your order)

PERMISSIONS_NO_PERMISSIONS

P020

No permissions have been assigned to this user. Contact your administrator.)

PERMISSIONS_GROUP_ID_NOT_FOUND

P045

There was an error retrieving your permission group. If problem persists, contact your administrator.)

PERMISSION_NOT_FOUND

P050

Requested/assigned permission not found. Contact your administrator.)

PERMISSIONS_UNAUTHORIZED

P075

User does not have permissions to perform this operation. Contact your administrator.)

PERMISSIONS_RESOURCE_PARENTIB_NOT_ASSIGNED

P087

No parentIB assigned to the resource entity. Contact your administrator.)

PERMISSIONS_BO_PARENTIB_NOT_ASSIGNED

P088

No parentIB assigned to the back office user. Contact your administrator.)

PERMISSIONS_PARENTIB_NO_MATCH

P090

The operator user and the operated resource do not belong to the same organization. Contact your administrator.)

REPORT_INVALID_DATE

R010

Invalid date.There are no reports available for the date(s) provided.)

REPORT_FUTURE_DATE

R011

Date in future.There are no reports available for the date(s) provided.)

SEARCH_NO_RECORDS_FOUND

S100

No records were found for the given search criteria. Modify your search and try again.)

PRODUCT_RIA_ID_INVALID_MISSING

T010

The riaID of product is missing or invalid. Refer to the API documentation for details.)

PRODUCT_TYPE_INVALID_MISSING

T011

A required type of product is missing or invalid. Refer to the API documentation for details.)

PRODUCT_FUND_ID_INVALID_MISSING

T012

A required fundID of product is missing or invalid. Refer to the API documentation for details.)

PRODUCT_OVERWEIGHT_ERROR

T013

A total weight of product is over 100%.)

PRODUCT_NOT_FOUND

P050

The product you were trying to retrieve was not found.)

QUOTES_SUCCESS

Q000

Quotes no RestError.)

QUOTES_NOT_FOUND

Q050

The quote you were trying to retrieve is not available.)

QUOTES_ERROR

Q100

There was an error in retrieving quotes.)

USER_NO_ERROR

U000

User No RestError.)

USERNAME_NOT_UNIQUE

U010

The username already exists.)

USER_INVALID_MISSING_PARAMETER

U025

Invalid or missing required parameter on the user. Refer to the API documentation for details.)

USER_INFO_DOCUMENT_MISSING

U040

A required document for the specified user or account type is missing incomplete. Refer to the API documentation for details.)

USER_NO_KYC

U045

The user is not in the KYC Queue.)

USER_NOT_FOUND

U050

The user you were trying to retrieve was not found. Please check the User ID and try again.)

USER_NO_PARENTIB_SET

U060

User does not have a parentIB set. Contact your administrator.)

USER_INVALID_PARENTIB_SET

U062

Unable to find parentIB associated with the user. Contact your administrator.)

USER_NO_REFERRER_PARENTIB_SET

U064

Referrer does not have a parentIB set. Contact your administrator.)

USER_INVALID_REFERRER_PARENTIB_SET

U065

Unable to find parentIB associated with the referrer. Contact your administrator.)

USER_NO_PRIVILEGES

U070

User does not have permissions to access this information. Contact your administrator.)

USER_NO_ACCESS

U072

User is not allowed to access this resource.)