Skip to navigation
API ReferenceAssets

List Assets

List all assets

Authentication

x-api-keystring
API Key authentication via header

Response

A paged array of assets
customerIdstringformat: "uuid"
typeenumOptional
marketValuefloatOptional

Balance or market value as entered on the asset checklist. For real estate the applicant rents out it is the yearly rent received; for SOLD_ASSET it is the market value minus the sale price.

interestRatefloatOptional

Interest rate as entered, in percent (1.5 is 1.5%).

cashConversionFeefloatOptional
categoryenumOptional

The asset checklist entry the asset was reported under. It tells apart assets that share a type: stocksOrBonds (SECURITY_STOCK; the checklist does not separate stocks from bonds), ira, pension, keogh, k401 and otherRetirementAccount (RETIREMENT_PLAN), realEstate and rentalProperty (REAL_ESTATE), other and federalTaxRefundOrCredit (OTHER).

cashValuefloatOptional

Value after the cost to convert the asset to cash (marketValue minus cashConversionFee, as entered).

disposedDatedateOptional

Date the asset was disposed of. Only on SOLD_ASSET.

disposedAmountfloatOptional

Amount disposed of for less than fair market value. Only on SOLD_ASSET.

propertyAddressstringOptional

Address of a real estate asset. Not populated yet; always null.

mortgageBalancefloatOptional

Unpaid mortgage balance of a real estate asset. Not populated yet; always null. The checklist folds the mortgage into cashConversionFee.

rentReceivedfloatOptional

Monthly rent received from a real estate asset. Always null; for rented real estate the yearly rent is in marketValue.

descriptionstringOptional

Free-text name of the asset where the checklist has one: the account type for retirement plans (IRA, Pension, Keogh, 401(k) or the name entered for another plan), and the name or type entered for personal property and other assets.

listTruncatedboolean or nullOptional

true when the checklist list this asset comes from holds more items than the API returns. Each list is returned up to a fixed number of items: 2 for other and 1 for every other list. Set on every asset read from a list: true when the list holds more, false when it ends within the cap. Null on assets not read from a list (cash held, sold assets, legacy-form entries).

idstringOptionalformat: "uuid"
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
applicantIdstringOptionalformat: "uuid"

The applicant (household member on the application) who reported the asset.

applicationIdstringOptionalformat: "uuid"
certificationIdstringOptionalformat: "uuid"

The certification whose asset checklist holds the asset. A customer has one checklist per certification, so the same asset can appear once per certification; filter on this field to read one certification’s assets. Empty for assets reported on an application before it had a certification; read those by applicationId.

householdIdstringOptionalformat: "uuid"
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
customerobjectOptional