Get Citizen Trust Accounts

Gets the trust accounts for the specified user. If a clerk needs the associated agent's trust account, call the Get Citizen Accounts for the logged in clerk, and use its agentId response field as the {id} parameter for Get Citizen Trust Accounts.

Resource Information

Scope	users Deprecated scope name: get_citizenaccess_trustaccounts
App Type	All
Authorization Type	Access token
URI	/v4/citizenaccess/citizens/{id}/trustAccounts?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.3.5

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.	7.3.3.5
id	string	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.5
lang	String	No	�	Indicates the language applied.	7.3.3.5
limit	long	No	�	Indicates the number of items that are returned in each page.	7.3.3.5
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.3.5

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.3.5
result.account	string	The account ID number for the trust account.	7.3.3.5
result.associations	result.associations{}	The trust account associations.	7.3.3.5
result.associations.text	string	The localized display text.	7.3.3.5
result.associations.value	string	The value for the specified parameter.	7.3.3.5
result.balance	double	The balance of the trust account in dollars.	7.3.3.5
result.description	string	The description of the trust account.	7.3.3.5
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.5
result.isPrimary	string	Indicates whether or not to designate the trust account as the primary source.	7.3.3.5
result.ledgerAccount	string	The ledger account of the trust account.	7.3.3.5
result.overdraft	string	Indicates whether or not the trust account can use the overdraft option.	7.3.3.5
result.overdraft.text	string	The localized display text.	7.3.3.5
result.overdraft.value	string	The value for the specified parameter.	7.3.3.5
result.overdraftLimit	Double	The overdraft limit amount, in dollars, for the trust account.	7.3.3.5
result.serviceProviderCode	string	The unique agency identifier.	7.3.3.5
result.status	string	The status of the trust account.	7.3.3.5
result.status.text	string	The localized display text.	7.3.3.5
result.status.value	string	The value for the specified parameter.	7.3.3.5
result.thresholdAmount	Double	The minimum amount required in a trust account.	7.3.3.5
status	integer	The record status.	7.3.3.5