Income calculations

This API provides income values based on the specified guidelines for a Book type. The supported income types include wage-earner, self-employed, rental, and other income. A detailed description of income-related fields found in the calculated_fields objects within the totals array can be found in the income calculation definition. These fields include attributes like field name, default value, and title/header to identify and interpret each data point.

👍

Tips

To retrieve Fannie Mae income calculation data, first call the Fannie Mae self-employed income calculation API, and then call the this income calculation API.

Path Params
uuid
required

The unique identifier of the Book from which the income calculations are retrieved.

Query Params
string
enum
Defaults to FANNIE_MAE

The guideline to be used for retrieving the income calculations. Supported values include FANNIE_MAE, FREDDIE_MAC, FHA, VA, and USDA.

Allowed:
Responses

Language
Credentials
OAuth2
Response
Choose an example:
application/json