Deprecated items in the DriveWealth data model

Overview

A deprecated item still works today, but you should not build anything new on it. This page lists every deprecated endpoint, field, and enum value in the DriveWealth API in one place, tells you what to use instead, and shows you how to find the deprecated items your integration depends on.

📘
What "deprecated" means here
Deprecated items stay available in UAT and production until their retirement date. DriveWealth publishes the retirement date in the changelog, normally at least 12 months after the deprecation date. See the API lifecycle guide for the full policy.

On this page

Quick triage
Deprecated endpoints
Deprecated fields
Deprecated enum values
Deprecated fields in events

Quick triage

Find the row that matches what you do today.

If your integration…	You are affected by	Start here
Calls `POST /auth`	A deprecated endpoint	Authentication
Calls the account summary or subscriptions endpoints	Deprecated endpoints	Deprecated endpoints
Reads pattern day trading fields (`patternDayTrader`, `pdtRestricted`, …)	Deprecated fields on accounts, deposits, violations, margin, and webhook events	Pattern day trading fields
Sends `wlpFinTranTypeID` when approving withdrawals	A deprecated request field	Withdrawals
Creates users with `investmentObjectives` or national ID types	Deprecated enum values	Deprecated enum values

Deprecated endpoints

The whole endpoint is deprecated.

Deprecated endpoint	Use instead	Migration guide	Deprecated since	Retirement date
`GET /accounts/{accountID}/summary`	The individual account endpoints: `summary/money`, `summary/margin`, `summary/positions`, `summary/orders`, and `GET /accounts/{accountID}/transactions`	Retrieve Account Summary migration guide	Apr 2023	March 24, 2027
`GET /accounts/{accountID}/summary/transactions`	`GET /accounts/{accountID}/transactions` for historical transactions. Use the account orders endpoint for orders.	Retrieve Account Summary migration guide	Mar 2025	March 24, 2027
`POST /auth`	`POST /auth/tokens` (Create Session Token)	See Authentication	Jan 2023	March 24, 2027
`POST /subscriptions`	None. The Subscriptions product is no longer supported.	—	Mar 2025	March 24, 2027
`DELETE /subscriptions/{subscriptionID}`	None. The Subscriptions product is no longer supported.	—	Mar 2025	March 24, 2027
`GET /users/USERID/subscriptions`	None. The Subscriptions product is no longer supported.	—	Mar 2025	March 24, 2027

Authentication

POST /auth and POST /auth/tokens both return a token for later requests. Switch to POST /auth/tokens, which the API reference labels "Create Session Token".

Deprecated fields on supported endpoints

These endpoints are not deprecated. Only the listed field is. The Action column tells you what to change:

Stop sending: remove the field from your requests.
Stop reading: remove the field from your response handling. Responses may keep returning it until the retirement date.

Pattern day trading fields

The SEC and FINRA eliminated the pattern day trader (PDT) rule, including its $25,000 minimum account requirement. The fields below described PDT status, so they are deprecated and will be removed in a future release.

Because the rule no longer exists, these fields have no replacement. Remove any logic in your integration that depends on them.

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`account.patternDayTrader`	Response of `GET /accounts/{accountID}` and `PATCH /accounts/{accountID}`	Stop reading	June 2026	None. The PDT rule no longer exists.
`account.pdtRestricted`	Same as above	Stop reading	June 2026	None. The PDT rule no longer exists.
`account.patternDayTrades`	Same as above	Stop reading	June 2026	None. The PDT rule no longer exists.
`patternDayTrades`	Response of `POST /accounts` and `GET /users/USERID/accounts`	Stop reading	June 2026	None. The PDT rule no longer exists.
`accountDetails[].patternDayTrades`	Response of `GET /funding/deposits`, `GET /funding/deposits/{depositID}`, and `PATCH /funding/deposits/{depositID}/achSettlement`	Stop reading	June 2026	None. The PDT rule no longer exists.
`patternDayTrades`	Response of `GET /accounts/{accountID}/violations`	Stop reading	June 2026	None. The PDT rule no longer exists.
`violations.patternDayTrades`	Response of `GET /accounts/{accountID}/summary/violations`	Stop reading	June 2026	None. The PDT rule no longer exists.
`margin.patternDayTrader`	Response of `GET /accounts/{accountID}/summary/margin`	Stop reading	June 2026	None. The PDT rule no longer exists.

Account restrictions

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`account.restricted`	Response of `GET /accounts/{accountID}` and `PATCH /accounts/{accountID}`	Stop reading	Dec 2023	No replacement documented. Contact us (below).

Instruments

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`type`	Response of `GET /instruments`, `GET /instruments/{symbolOrInstrumentID}`, and `POST /instruments/filter`	Stop reading	Jul 2023	`instrumentType`, which is returned in the same objects. The value sets differ. See the table below.

type and instrumentType don't use the same values:

Value	In `type`	In `instrumentType`
`EQUITY`	✅	✅
`ALTERNATIVE_ASSET`	✅	✅
`MUTUAL_FUND`	✅	✅
`ETF`	✅	❌
`ETN`	✅	❌
`ADR`	✅	❌
`INTEREST_RATE`	✅	❌
`DEBT`	❌	✅
`OPTION`	❌	✅
`CRYPTO`	❌	✅

Users and onboarding

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`wlpID`	Request of `POST /users`	Stop sending	Feb 2023	None documented. The spec says only partners onboarded before 10/1/22 needed to send it.
`parentIBID`	Request of `POST /users`	Stop sending	Feb 2023	None documented. The spec says only partners onboarded before 10/1/22 needed to send it.
`documents[].data.optionsSuitability`	Request and response of `POST /users`	Stop sending and reading	May 2026	`documents[].data.equitiesExperience` and `documents[].data.optionsExperience`, which sit directly under `data` and are required for options onboarding.

Withdrawals

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`wlpFinTranTypeID`	Request of `PATCH /funding/redemptions/{redemptionID}`	Stop sending	—	`transactionCode`

📘
Only the top-level field is deprecated
When you attach a fee line item to a withdrawal approval, the fee's own wlpFinTranTypeID is a separate field that is still supported.

Asset transfers

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`clearingNo`	Response of `POST /asset-transfers/transfers`	Stop reading	Sep 2026	None. It isn't needed for internal transfers.

Cash

Deprecated field	Where it appears	Action	Deprecated since	Use instead
`cash.pendingPaymentsAmount`	Response of `GET /accounts/{accountID}/summary/money`	Stop reading	Sep 2026	No replacement documented. Contact us (below).

Deprecated enum values

The enum itself still works. Only the listed values are deprecated.

User investment objectives

Applies to investmentObjectives and secondaryInvestmentObjectives on POST /users, PATCH /users/USERID, and GET /users/USERID.

Deprecated value	Replaced by
`LONG_TERM`	`CAPITAL_PRESERVATION` and/or `GROWTH`
`INFREQUENT`	`CAPITAL_PRESERVATION` and/or `INCOME`
`FREQUENT`	`GROWTH` and/or `INCOME`
`ACTIVE_DAILY`	`GROWTH` and/or `SPECULATION`

Identification types

Deprecated value	Applies to	Replaced by
`FTNLO`	`documents[].data.type` on `POST /users` and `PATCH /users/USERID`	None documented. Don't use it for new integrations.

Deprecated fields in events

Event	Deprecated field	Action
`accounts.created`	`pdtRestricted`	Stop reading
`accounts.updated`	`pdt`, the object that holds all pattern day trading fields	Stop reading
`violations.created`, `violations.removed`	`currentViolations.patternDayTrades`	Stop reading

The PDT deprecation in events matches the pattern day trading fields in the REST API.