Permissions

This method requires the scopeaccount.read.pii_highto be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal. A PII high scope is required because responses contain sensitive information like names, addresses, tax identification numbers, and information about investor eligibility.

Filters

Filters limit the values included in responses to those defined. Filters only support full equality. Expressions and inequalities are not supported at this time. All filters are ANDed together, meaning a record must match all filters to be included in the response.

/v3/accounts?filter={"type":"Individual", "state":"AL"}  
/v3/accounts?filter[type]=Individual&filter[state]=AL

This also allows for filtering lists. Lists are inclusive in a this or that relationship meaning records that match any value in the list will be included in the result.

/v3/accounts?filter={"state": ["AL", "WY"], "type": "Individual"}  
/v3/accounts?filter[state]=AL&filter[state]=WY&filter[type]=Individual

For more information on filtering see

Working with List Endpoints

200200

400400

422422