HomeGuidesAPI Reference

BorrowerPayload

Payitoff API: BorrowerPayload Schema

🚧

Use BorrowerPayload for API POST, PUT, and PATCH requests

For historical reasons, the request payload required when creating and updating a Borrower via our v1 API has a different shape than the response object. Thus, you must use a BorrowerPayload for your API request payloads, and expect a Borrower as the response.

This discrepancy will be corrected in API v2.

Schema Definition

PropertyTypeFormatDescription
addressobjectAddressAn Address object.
aginumberfloatThe Borrower's Adjusted Gross Income.
childrenintegerint32The number of children (including unborn) the borrower has.
collecting_unemploymentbooleanIs this person collecting unemployment?

Defaults tofalse.

Required for Enrollment.
dependentsintegerint32The number of non-children dependents who receive more than half their support from the borrower.
emailstringemailThe Borrower's email address.
employerstringIf Borrower is employed, the name of their employer.
employer_start_datestringdateIf Borrower is employed, date on which they began working for their employer.
employer_statestringState where Employer is located (state code).
extra_monthly_paymentnumberfloatThe amount of additional payment, if any, the borrower wishes to make on their loan(s).
family_sizeintegerint32Number 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_statusstringsingle
head_of_household
married_filing_jointly
married_filing_separately
Federal tax filing status of Borrower.

Defaults to single.
first_namestringBorrower first name.
income_certificationobjectIncomeCertificationPayloadIf adding/updating supporting documentation for Income Certification, supply an IncomeCertificationPayload.
income_growthnumberfloatExpected income growth per year, as a percentage.

Defaults to 5.0.
last_namestringBorrower last name.
new_borrower_datestringdateThe date on which the Borrower first took out student loans.
phonestringBorrower phone number.
pslfbooleanInstructs Payitoff to include PSLF forgiveness in Assessment calculations.

Defaults to null.
refinance_ratenumberfloatTODO
refinance_termintegerint32TODO
related_to_majorbooleanTODO
residencestringmaxLength: 22-letter US state code indicating what state the Borrower legally resides in.
spouse_aginumberfloatIf the Borrower has a spouse, the spouse's 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.
spouse_idintegerint64If you wish to have a borrower and their spouse represented in the API and connected for Assessment operations, first create one of the married borrowers via API, then supply their Borrower ID as the other borrower's spouse_id. The married borrowers will be connected.

NOTE: Don't forget to update family_size and filing_status.
ssnstringBorrower Social Security Number.

Required for Enrollment.
state_of_residencestringmaxLength: 22-letter US state code indicating what state the Borrower legally resides in.
student_statusstringunknown
withdrawn
leave_of_absence
quarter_time
three_quarter_time
less_than_half
less_than_half_time
half_time
full_time
graduated
Borrower's student status.
student_status_effective_datestringdateThe date on which the current student_status went into effect.
tcli_enabledbooleanInstructs Payitoff to include TCLI forgiveness in Assessment calculations.

Defaults to null.
teaching_levelstringelementary
middle
secondary
If Borrower is a teacher, what level of education they teach.
teaching_statestringIf Borrower is a teacher, the state where employing school is located.
teaching_subjectstringenglish
math
other
science
special_education
If Borrower is a teacher, the subject they teach.
unemployedbooleanIs this person unemployed?

Defaults to false.

Required for Enrollment.

Example

{
  "borrower": {
    "first_name": "James",
    "last_name": "Kirk",
    "family_size": 2,
    "agi": 45500.45,
    "spouse_agi": 24000,
    "state_of_residence": "NV",
    "employer": "City Of Albemarle",
    "employer_start_date": "2015-12-10",
    "filing_status": "single",
    "email": "[email protected]",
    "phone": null,
    "ssn": "123-45-6789",
    "address": {
      "street1": "123 Main St",
      "city": "Anytown",
      "state": "MN",
      "zipcode": "12345"
    }
  }
}