API Reference
  1. ACCOUNTS API
  2. Accounts - Client

Update client account

post
https://wealth-rest-api.softwarealgo.com/v1/client/update

Update client account details only, without owner details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Primary client account details. Each client is uniquely identified by an account ID.

int64

Account unique identifier generated by the system, required on edit

string
required
length between 4 and 4

The name given to a bank, broker, dealer, or financial institution that acts on behalf of another financial institution. Four Alpha numeric character. Required in create. Value is disregarded on update.

string

The alphanumeric identifier of the account.

string
required

Refers to the account holder name of the individual or an entity

string

Master or roll-up account. Alphanumeric master account number which can be used across the system. If blank, master_account_no = account_no

string
required

Check /v1/systemcode/list API for valid values (type = 'Status', subType = 'Client Setup'), use the 'code' value.

date-time

Date time when the account status was set to Active.

date-time

Date time when the account status was set to Pending Closure.

string
required

A broker is an individual or firm that charges a fee or commission for executing buy and sell orders submitted by an investor. Check /v1/systemcode/list API for valid values (type = 'Broker'), use the 'code' value.

boolean

An indicator if the client is a participant of the Fully Paid for Stock Lending (FPSL).

string
required

Any voluntary, specific, and informed expression of will in terms of which permission is given for the processing of personal information. Check /v1/systemcode/list API for valid values (type = 'Privacy Consent'), use the 'code' value.

boolean

A day trader engages in long and short trades in an attempt to profit by capitalizing on the intraday movements of a market’s price action resulting from temporary inefficiencies in the supply and demand of the moment.

string

The contract multiplier (also called contract size) is different for most classes of options and is determined by each exchange.

string

Check /v1/systemcode/list API for valid values (type = 'Investment Objective'), use the 'code' value.

investmentObjectiveDate
object
  • A full date, with non-zero year, month and day values
  • A month and day value, with a zero year, e.g. an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, e.g. a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

string
required

An association, corporation, partnership, proprietorship, trust, or individual that has legal standing in the eyes of the law. A legal entity has the legal capacity to enter into agreements or contracts, assume obligations, incur and pay debts, sue and be sued in its own right, and be held responsible for its actions. Check /v1/systemcode/list API for valid values (type = 'Legal Entity'), use the 'code' value.

string
required

The client's legal tax country. This will affect the client's tax declarations. Check /v1/systemcode/list API for valid values (type = 'Country'), use the 'code' value.

string
required

Check /v1/systemcode/list API for valid values (type = 'W8/W9'), use the 'code' value.

w8w9ReceivedDate
object
  • A full date, with non-zero year, month and day values
  • A month and day value, with a zero year, e.g. an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, e.g. a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

string
required

The Tax Equity and Fiscal Responsibility Act of 1982 (Pub.L. 97–248),[1] also known as TEFRA, is a United States federal law that rescinded some of the effects of the Kemp-Roth Act passed the year before. As a result of the ongoing recession, a short-term fall in tax revenue generated concern over the budget deficit. TEFRA was created in order to reduce the budget gap by generating revenue through the closure of tax loopholes and the introduction of tougher enforcement of tax rules, as opposed to changing marginal income tax rates. TEFRA was introduced on November 13, 1981, and was sponsored by Representative Pete Stark of California. After much deliberation, the final version was signed by President Ronald Reagan on September 3, 1982. Check /v1/systemcode/list API for valid values (type = 'TEFRA'), use the 'code' value.

boolean

It is an individual or a business entity that is allowed to trade securities that may not be registered with financial authorities. They are entitled to this privileged access by satisfying at least one requirement regarding their income, net worth, asset size, governance status, or professional experience.

boolean

An indicator if the account has FDID.

string

It is a unique identifier for each trading account designated by Industry Members for purposes of providing data to the Central Repository, where each such identifier is unique among all identifiers from any given Industry Member for each business date.

string

Description or reason for the FDID expired or ended.

string

A branch office is a location, other than the main office, where a business is conducted. Most branch offices consist of smaller divisions of different aspects of the firm.

string

A registered representative (RR) is a person who works for a client-facing financial firm such as a brokerage company and serves as a representative for clients who are trading investment products and securities. Registered representatives may be employed as brokers, financial advisors, or portfolio managers.

string
required

It indicates the type of account such as ATS, Black Box, Share Holder, etc. Check /v1/systemcode/list API for valid values (type = 'Client Account Type', subType = 'Client Site'), use the 'code' value.

string
required

A margin type is the by brokerages that allow investors to borrow money to buy securities. An investor might put down 50% of the value of a purchase and borrow the rest from the broker. The broker charges the investor interest for the right to borrow money and uses the securities as collateral. Check /v1/systemcode/list API for valid values (type = 'Margin Type'), use the 'code' value.

string

The identification assigned by SEC for an individual who is considered as a large trader.

string

Concatenation of first name, last name, date of birth (yyyyMMdd), and the first and last two digits of the tax ID.

string

Based on the type of client account, this field can be used to specify the sub-type of the account.

string

Any description that will define why a certain status is assigned to the account.

boolean

An indicator if the account allows liquid assets to be used in transactions. A liquid investment is any investment that can be easily converted into cash without having a significant impact on its value.

date-time

The date when the client accepted the web terms and conditions.

date-time

The date when the client accepted the disclosure statement.

date-time

A fee schedule is a complete listing of fees This refers to the date assigned for payment of fees.

string

A beneficiary typically refers to someone eligible to receive distributions from a trust, will, or life insurance policy.

string

Identification of the organization that has the right to create or redeem shares of an ETF.

string

The identification number assigned to the trader.

boolean

An indicator for Margin Disclosure and an indicator if the user already read the Margin Disclosure Statement.

boolean

An indicator if stock is part of the trading privileges.

boolean

An indicator if ETF is part of the trading privileges.

boolean

An indicator if Option is part of the trading privileges.

string

The total amount of money you make each year before deductions are taken out of your pay. Check /v1/systemcode/list API for valid values (type = 'Investment Objectives', subType = 'Annual Income'), use the 'code' value.

string

The amount of money you've got in cash or cash equivalents after you deducted your liabilities from your liquid assets. Check /v1/systemcode/list API for valid values (type = 'Investment Objectives', subType = 'Liquid Net Worth'), use the 'code' value.

string

Identifies in one manner how the account will be funded.. Check /v1/systemcode/list API for valid values (type = 'Fund Source'), use the 'code' value.

boolean

An indicator if the account is signed.

string

Text/Image of the signature of the client.

boolean

An indicator if the client has signed the margin agreement.

string

KYC, also called Know Your Customer, is a method of identifying and verifying customers of a bank or investors in stocks, mutual funds, and other investments. Options are 'Approved', 'Denied', 'Failed', 'Pending', or 'Warning'.

string

The currency that will be used by the account. Check /v1/systemcode/list API for valid values (type = 'Currency'), use the 'code' value.

string

Promotional code is a code that can be used to get a discount or a special offer. It is usually a combination of letters and numbers.

int32

The range of incomes taxed at given rates, which typically differs depending on filing status.

string

Risk tolerance refers to the amount of loss an investor is prepared to handle while making an investment decision. Check /v1/systemcode/list API for valid values (type = 'Risk Tolerance'), use the 'code' value.

boolean

An indicator if the client has signed the customer account agreement.

string

The percentage of the onboarding process.

string

Tax Identification Number is a tax processing number only available for certain nonresident and resident aliens, their spouses, and dependents who cannot get a Social Security Number (SSN). It is a 9-digit number, beginning with the number 9 formatted like an SSN (NNN-NN-NNNN).

string

The country where an organization's incorporation is formed. Check /v1/systemcode/list API for valid values (type = 'Country'), use the 'code' value.

string

This identifies an email box to which messages are delivered.

lastActivityDate
object
  • A full date, with non-zero year, month and day values
  • A month and day value, with a zero year, e.g. an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, e.g. a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

boolean

An indicator if Mutual Funds is part of the trading privileges.

boolean

An indicator if Fixed Income is part of the trading privileges.

string

The state where an organization's incorporation is formed. Check /v1/systemcode/list API for valid values (type = 'State'), use the 'code' value.

formationDate
object
  • A full date, with non-zero year, month and day values
  • A month and day value, with a zero year, e.g. an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, e.g. a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

string

The name assigned to the service bureau account. Check /v1/systemcode/list API for valid values (type = 'Service Bureau'), use the 'code' value.

boolean

An indicator if account allows a cash sweep.

string

Check /v1/systemcode/list API for valid values (type = 'PL Type'), use the 'code' value.

date-time

Date time when the account status was set to Closed.

date-time

Date time when the account status was set to On Hold.

Response

Updated 9 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

Did this page help you?