HomeGuidesAPI Reference




For historical reasons, `FinancialDetails` are returned as a nested object in `Borrower` responses. but most properties are accepted as direct `BorrowerPayload` properties when creating and updating your `Borrower` via API.

This discrepancy will be corrected in API v2.

### Schema Definition

PropertyTypeFormatDescription
`agi``number``float`The `Borrower`'s <<glossary:Adjusted Gross Income>>.
`children``integer``int32`The number of children (including unborn) a `Borrower` has. _Defaults to `0`._
`dependents``integer``int32`The number of non-children dependents who receive more than half their support from the `Borrower`. _Defaults to `0`._
`employer_state``string`
State in which the `Borrower`'s current employer is located.
`extra_monthly_payment``number``float`The amount of additional payment, if any, the `Borrower` wishes to make on their loan(s).
`family_size``integer``int32`Number of family members, including the Borrower, their spouse, their children (even unborn), and any other dependents who receive more than half of their support from the `Borrower`. _Defaults to `1`._
`filing_status``string``single` `head_of_household` `married_filing_jointly` `married_filing_separately`Federal tax filing status of `Borrower`. _Defaults to `single`._
`income_growth``number``float`Expected income growth per year, as a percentage. _Defaults to `5.0`._
`new_borrower_date``string``date`The date on which the `Borrower` first took out student loans.
`pslf``boolean`
Instructs Payitoff to include PSLF forgiveness in Assessment calculations. _Defaults to `null`._
`refinance_rate``number``float`TODO
`refinance_term``integer``int32`TODO
`related_to_major``boolean`
TODO
`spouse_agi``number``float`If the `Borrower` has a spouse, the spouse's <<glossary:Adjusted Gross Income>>. **NOTE:** `family_size` should be at least `2` if providing `spouse_agi` to be included in Assessment calculations. You should also choose one of the `married_*` `filing_status` values.
`state_of_residence``string`
State in which the borrower legally resides.
`tcli_enabled``boolean`
Instructs Payitoff to include TCLI forgiveness in Assessment calculations. _Defaults to `null`._
`tcli_end_year``string``date`TODO
`tcli_start_year``string``date`TODO
`teaching_level``string``elementary` `middle` `secondary`If `Borrower` is a teacher, what level of education they teach.
`teaching_state``string`
If `Borrower` is a teacher, the state where employing school is located.
`teaching_subject``string``english` `math` `other` `science` `special_education`If `Borrower` is a teacher, the subject they teach.`

### Example