Debt to Income Improvement
API reference for the Debt to Income Improvement endpoint.
Endpoints
/dti-improvement
POST
The /dti-improvement endpoint is used to calculate the debt to income improvement
for clients with student loans when they use our service. Additional data points
including the new student loan payment amount, the original student loan payment
amount, increased home purchasing power, and total home affordability will also be
provided. The endpoint accepts a JSON body with the following properties:
- Note that all properties are marked as required. If a property is not applicable, please pass in a value of 0.
studentLoanBalanceandaverageStudentLoanRateare not required iffederalStudentLoansis provided.
| Fields | Type | Required | Description |
|---|---|---|---|
| annualIncome | number | true | The client's annual income |
| federalStudentLoanBalance | number | true | The client's student loan balance |
| minCreditCardPayment | number | true | The client's minimum credit card payment |
| carPayment | number | true | The client's car payment |
| otherLoansMonthlyPayment | number | true | The client's other loans |
| averageStudentLoanRate | number | true | The client's average student loan rate. Number should be less than 1 and greater than 0 |
| familySize | number | true | The client's family size |
| acceptedDTI | number | true | The accepted dti ratio for underwriting |
| loanTerm | number | true | The loan term in years |
| mortgageInterestRate | number | true | The mortgage interest rate. Number should be less than 1 and greater than 0 |
| downPaymentPercentage | number | true | The down payment percentage. Number should be less than 1 and greater than 0 |
| federalStudentLoans | array | true | The client's federal student loans as an array of objects. See Student Loan Schema for more details. |
Example Request
In Node
import axios from "axios";
const response = await axios.post(
"https://api.myloansense.com/dti-improvement",
{
annualIncome: 50000,
minCreditCardPayment: 100,
carPayment: 200,
otherLoansMonthlyPayment: 100,
familySize: 1,
acceptedDTI: 0.45,
loanTerm: 30,
mortgageInterestRate: 0.05,
downPaymentPercentage: 0.10,
federalStudentLoans: [
{
balance: 45000,
interestRate: 0.04,
type: 'DIRECT"',
servicer: 'Mohela'
},
{
balance: 55000,
interestRate: 0.035,
type: 'DIRECT',
servicer: 'Mohela'
}
]
},
headers: { 'x-api-key': '{{API_KEY}}'});Example Response
{
"newStudentLoanPayment": 201,
"originalStudentloanPayment": 1061,
"increasedPurchasingPower": 122304,
"totalAffordability": 181264,
"dti": 0.14
}Student Loan Schema
| Fields | Type | Required | Description |
|---|---|---|---|
| balance | number | true | The student loan balance |
| interestRate | number | true | The student loan interest rate |
| type | string | false | The student loan type |
| servicer | string | false | The student loan servicer |