List client accounts

get

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

Returns list of client account details without owner details based on the filter criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

correspondent

string

The name given to a bank, broker, dealer, or financial institution that acts on behalf of another financial institution. Four Alpha numeric character.

branch

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.

accountNo

string

The alphanumeric identifier of the account.

accountName

string

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

masterAccountNo

string

Master or roll-up account. Alphanumeric master account number which can be used across the system.

rep

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.

status

string

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

broker

string

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.

pagination.pageSize

int64

Number of records to return per page. Used to control the size of each paginated response.

pagination.pageNo

int64

Zero-based index of the page to retrieve. For example, page_no = 0 returns the first page.

pagination.sortName

string

Name of the field to sort by. Leave empty for default sorting behavior.

pagination.sortDirection

string

Sorting order for the results. Acceptable values are 'asc' for ascending and 'desc' for descending.

pagination.filterNames

array of strings

List of field names to apply filters on. Must correspond to valid queryable fields.

pagination.filterNames

pagination.filterValues

array of strings

List of values corresponding to each filter name. The position of each value must match the position of its filter name.

pagination.filterValues

Response

200A successful response.