Returning Assumptions

The BB.api.rateflow.assumptions method retrieves mortgage assumptions based on a given rateflow_log_id. This API provides key details about the assumed loan scenario, such as the loan amount, interest rate, APR, and estimated monthly payment.

Usage example

BB.api.rateflow.assumptions({ log_id: 1234, fields: true })

Parameters

log_id (number, required) – The unique identifier for the rateflow_log_id.
fields (boolean, optional) – If true, the response includes additional loan details under the fields property. Defaults to false.

Response wtructure

The API returns a Promise resolving to an object with the following properties:

assumptions (string) – A textual summary of the mortgage scenario, including the loan amount, property details, interest rate, and monthly payment.
fields (optional object) – If fields is set to true, the response includes a structured breakdown of loan details such as credit_score, loan_amount, rate, etc.

Example responses

Without fields (default)

{  
"assumptions": "The information provided is for a 30 years fixed mortgage and assumes the purpose  of the loan is to purchase a property, with a loan amount of $200,000 and estimated property value of $250,000.The property is an existing single family home and will be used as a primary residence and is located in South Carolina.\\n An escrow account is required. The rate lock period is 30 days and the assumed credit score is 731, at a 6.875% interest rate, the fixed APR for this loan scenario is 6.992%. The monthly payment would be: $1,314.\\n\\nThe monthly payment amount displayed includes principal and interest.\\nThe payment amount does not include homeowner's insurance, property taxes or any required mortgage insurance, which must be paid in addition to your loan payment. Actual APR based on credit worthiness. Quote ID: 42645"  
}

With fields

{
   "assumptions": "The information provided is for a 30 years fixed mortgage and assumes the purpose  of the loan is to purchase a property, with a loan amount of $200,000 and estimated property value of $250,000.\nThe property is an existing single family home and will be used as a primary residence and is located in South Carolina.\n An escrow account is required. The rate lock period is 30 days and the assumed credit score is 731, at a 6.875% interest rate, the fixed APR for this loan scenario is 6.992%. The monthly payment would be: $1,314.\n\nThe monthly payment amount displayed includes principal and interest.\nThe payment amount does not include homeowner's insurance, property taxes or any required mortgage insurance, which must be paid in addition to your loan payment. Actual APR based on credit worthiness. Quote ID: 42645",
   "fields": {
       "credit_score": "731",
       "lock_period": 30,
       "address": "123 Main Street, Charleston, (29403) South Carolina",
       "county": "Charleston",
       "state": "South Carolina",
       "loan_purpose": "purchase",
       "list_price": 250000,
       "loan_amount": 200000,
       "down_payment": 50000,
       "down_payment_percentage": 20,
       "property_type": "single_family_home",
       "residency_type": "primary_home",
       "title": "FHLMC 30 Yr Fixed ",
       "term": 30,
       "armTerm": null,
       "amortization": 30,
       "amortization_type": "Fixed",
       "apr": "6.992",
       "rate": "6.875",
       "monthly_payment": 1314,
       "quote_id": "42645"
   }
}

By default, the assumption response is stored for an hour in local storage.

You could set that to false or change the expiration time:

BB.api.rateflow.assumptions({log_id: 1234, fields:true, cacheEnabled: false})  
BB.api.rateflow.assumptions({log_id: 1234, fields:true, expiresIn: 7200000})