Assets Overview

The Assets API returns the assets each applicant reported on the asset checklist of an affordable certification: bank accounts, cash, certificates of deposit, trusts, stocks and bonds, retirement plans, life insurance, real estate, personal property held for investment, assets disposed of, and other assets.

Key Concepts

One asset per checklist entry

Each asset is one entry of an applicant’s asset checklist. An applicant has one checklist per certification, so the same account can appear once for the move-in certification and again for a recertification. Use certificationId (or applicationId) to read the assets of one certification.

Type and category

type is the asset kind (ACCOUNT_CHECKING, RETIREMENT_PLAN, SOLD_ASSET, …). category is the checklist entry the asset was reported under and separates assets that share a type: ira, pension, keogh, k401 and otherRetirementAccount are all RETIREMENT_PLAN; stocksOrBonds is SECURITY_STOCK because the checklist does not tell stocks from bonds.

Values

• marketValue: the balance or market value as entered.
• cashConversionFee: the cost to convert the asset to cash. For real estate entered in the portal it holds the mortgage balance, plus the cost to sell when the property is being sold.
• cashValue: the value after that cost.
• interestRate: in percent.
• Real estate the applicant rents out (portal): marketValue is the yearly rent received, cashConversionFee the yearly taxes, cashValue the rent after taxes and interestRate the interest portion entered, not a market value or a mortgage.
• SOLD_ASSET entered in the portal: marketValue and cashValue are the amount given away, the market value minus the sale price, the same number as disposedAmount.
• disposedDate and disposedAmount: only on SOLD_ASSET.

A value that was not entered as a number is returned as null.

Older checklists

Certifications whose asset checklist was filled in on the older form (one value per asset type, no list of accounts) return one asset per type marked yes. That form holds a single value, so marketValue and cashValue are the same and interestRate and cashConversionFee are null. On SOLD_ASSET the value is also returned as disposedAmount.

Not returned yet

• Every entry of a long list. Each account list returns its first entry only (the first two for other assets); when an applicant reported more, that last returned asset has listTruncated: true. Do not add up marketValue or cashValue for an applicant’s asset total while any asset of that certification has listTruncated: true.
• The institution name and account number: they are stored encrypted and will be added separately.
• propertyAddress, mortgageBalance and rentReceived are declared but always null: the checklist does not store them.
• Assets of minors (household members who are not customers).

Customer assets

GET /customers/{customerId}?fields=assets.* and GET /customers?fields=assets.* return each customer’s assets, matched on customerId.

Available Endpoints