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

Scopeusers

Deprecated scope name:   get_citizenaccess_trustaccounts

App TypeAll
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/{id}/trustAccounts?offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.5

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo 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
idstringNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
langStringNo Indicates the language applied.7.3.3.5
limitlongNo Indicates the number of items that are returned in each page.7.3.3.5
offsetlongNo Indicates the offset start of each page by the number specified.7.3.3.5

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.3.5
result.accountstringThe account ID number for the trust account.7.3.3.5
result.associationsresult.associations{}The trust account associations.7.3.3.5
result.associations.textstringThe localized display text.7.3.3.5
result.associations.valuestringThe value for the specified parameter.7.3.3.5
result.balancedoubleThe balance of the trust account in dollars.7.3.3.5
result.descriptionstringThe description of the trust account.7.3.3.5
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
result.isPrimarystringIndicates whether or not to designate the trust account as the primary source.7.3.3.5
result.ledgerAccountstringThe ledger account of the trust account.7.3.3.5
result.overdraftstringIndicates whether or not the trust account can use the overdraft option.7.3.3.5
result.overdraft.textstringThe localized display text.7.3.3.5
result.overdraft.valuestringThe value for the specified parameter.7.3.3.5
result.overdraftLimitDoubleThe overdraft limit amount, in dollars, for the trust account.7.3.3.5
result.serviceProviderCodestringThe unique agency identifier.7.3.3.5
result.statusstringThe status of the trust account.7.3.3.5
result.status.textstringThe localized display text.7.3.3.5
result.status.valuestringThe value for the specified parameter.7.3.3.5
result.thresholdAmountDoubleThe minimum amount required in a trust account. 7.3.3.5
statusintegerThe record status.7.3.3.5