BorrowerPayload
Payitoff API: BorrowerPayload
Schema
Use
BorrowerPayload
for APIPOST
,PUT
, andPATCH
requestsFor 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 aBorrowerPayload
for your API request payloads, and expect aBorrower
as the response.This discrepancy will be corrected in API v2.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
|
| An | |
|
|
| The |
|
|
| The number of children (including unborn) the borrower has. |
|
| Is this person collecting unemployment? Defaults to Required for Enrollment. | |
|
|
| The number of non-children dependents who receive more than half their support from the borrower. |
|
|
| The |
|
| If | |
|
|
| If |
|
| State where Employer is located (state code). | |
|
|
| The amount of additional payment, if any, the borrower wishes to make on their loan(s). |
|
|
| 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 Defaults to |
|
|
| Federal tax filing status of Defaults to |
|
|
| |
|
| If adding/updating supporting documentation for Income Certification, supply an | |
|
|
| Expected income growth per year, as a percentage. Defaults to |
|
|
| |
|
|
| The date on which the |
|
|
| |
|
| Instructs Payitoff to include PSLF forgiveness in Assessment calculations. Defaults to | |
|
|
| TODO |
|
|
| TODO |
|
| TODO | |
|
|
| 2-letter US state code indicating what state the |
|
|
| If the NOTE: |
|
|
| If 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 NOTE: Don't forget to update |
|
|
Required for Enrollment. | |
|
|
| 2-letter US state code indicating what state the |
|
|
|
|
|
|
| The date on which the current |
|
| Instructs Payitoff to include TCLI forgiveness in Assessment calculations. Defaults to | |
|
|
| If |
|
| If | |
|
|
| If |
|
| Is this person unemployed? Defaults to 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"
}
}
}
Updated 9 months ago