Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| interestRate |
The interest rate. |
decimal number |
Required |
Body Parameters
The scenario.
QuickPreQualificationScenario| Name | Description | Type | Additional information |
|---|---|---|---|
| annualHomeownersInsurance |
Gets or sets the homeowners insurance. |
decimal number |
None. |
| annualPropertyTax |
Gets or sets the property tax. |
decimal number |
None. |
| callbackUrl |
Gets or sets the callback URL. |
string |
None. |
| complete |
Gets or sets a value indicating whether this is complete (got person info). |
boolean |
None. |
| contactMe |
Gets or sets a value indicating whether the user asks to contact me. |
boolean |
None. |
| creditReportAuthorizedUrl |
Gets or sets the credit report authorized URL. |
URI |
None. |
| creditReportAuthorizedClientIp |
Gets or sets the IP address of the client who authorized the credit report to be pulled. |
string |
None. |
| giftFundsAmount |
Gets or sets the gift funds amount. |
decimal number |
None. |
| hadBankruptcy |
Gets or sets a value indicating whether had bankruptcy. |
boolean |
None. |
| hadForeclosure |
Gets or sets a value indicating whether had foreclosure. |
boolean |
None. |
| hadShortSale |
Gets or sets a value indicating whether had short sale. |
boolean |
None. |
| hasRental |
Gets or sets a value indicating whether has rental. |
boolean |
None. |
| hasSecondHome |
Gets or sets a value indicating whether has second home. |
boolean |
None. |
| isBorrowingMoney |
Gets or sets a value indicating whether this is borrowing money for down payment and closing costs. |
boolean |
None. |
| monthlyDebtPayment |
Gets or sets the monthly debt payment. |
decimal number |
None. |
| monthlyHOADues |
Gets or sets the monthly hoa dues. |
decimal number |
None. |
| monthlyRent |
Gets or sets the monthly rent. |
decimal number |
None. |
| netRentalIncome |
Gets or sets the net rental income. |
decimal number |
None. |
| otherTaxesAndInsurances |
Gets or sets the property tax. |
decimal number |
None. |
| primaryResidenceExpense |
Gets or sets the primary residence expense. |
decimal number |
None. |
| referralSource |
Gets or sets the referral source. |
string |
None. |
| secondHomePayments |
Gets or sets the second home payments. |
decimal number |
None. |
| securedBorrowedFunds |
Gets or sets the secured borrowed funds. |
decimal number |
None. |
| totalLiquidAssets |
Gets or sets the total liquid assets. |
decimal number |
None. |
| transactionId |
Gets or sets the transaction identifier. |
string |
None. |
| usingGiftFunds |
Gets or sets a value indicating whether using gift funds for down payment and closing costs. |
boolean |
None. |
| borrowers |
Gets the borrowers. |
Collection of QuickPreQualificationBorrower |
None. |
| countyId |
Gets or sets the county. |
integer |
None. |
| loanOfficerId |
Gets or sets the loan officer identifier. |
integer |
None. |
| appraisedValue |
Gets or sets the appraised value. |
decimal number |
None. |
| corporatePartner |
Gets or sets the corporate partner. |
string |
None. |
| countyFipsId |
Gets or sets the county. |
string |
None. |
| creditScore |
Gets or sets the credit score. |
integer |
None. |
| escrowsWaived |
Gets or sets a value indicating whether escrows are waived. |
boolean |
None. |
| isCashOut |
Gets or sets a value indicating whether is cash out. |
boolean |
None. |
| loanAmount |
Gets or sets the loan amount. |
decimal number |
None. |
| loanProductId |
Gets or sets the loan product identifier. |
integer |
None. |
| loanPurpose |
Gets or sets the loan purpose. |
string |
None. |
| lockPeriod |
Gets or sets the lock period. |
integer |
None. |
| miRateTypeId |
Gets or sets the mi rate type identifier. |
integer |
None. |
| occupancyType |
Gets or sets the type of the occupancy. |
string |
None. |
| organization |
Gets or sets the organization. |
string |
None. |
| promoCode |
Gets or sets the promo code. |
string |
None. |
| propertyTypeId |
Gets or sets the property type identifier. |
integer |
None. |
| salesPrice |
Gets or sets the sales price. |
decimal number |
None. |
| state |
Gets or sets the state. |
string |
None. |
Request Formats
application/json, text/json
{
"annualHomeownersInsurance": 1.0,
"annualPropertyTax": 1.0,
"callbackUrl": "sample String 1",
"complete": true,
"contactMe": true,
"creditReportAuthorizedUrl": "http://webapihelppage4.com",
"creditReportAuthorizedClientIp": "sample String 5",
"giftFundsAmount": 1.0,
"hadBankruptcy": true,
"hadForeclosure": true,
"hadShortSale": true,
"hasRental": true,
"hasSecondHome": true,
"isBorrowingMoney": true,
"monthlyDebtPayment": 1.0,
"monthlyHOADues": 1.0,
"monthlyRent": 1.0,
"netRentalIncome": 1.0,
"otherTaxesAndInsurances": 1.0,
"primaryResidenceExpense": 1.0,
"referralSource": "sample String 11",
"secondHomePayments": 1.0,
"securedBorrowedFunds": 1.0,
"totalLiquidAssets": 12.0,
"transactionId": "sample String 13",
"usingGiftFunds": true,
"borrowers": [],
"countyId": 14,
"loanOfficerId": 1,
"appraisedValue": 1.0,
"corporatePartner": "sample String 15",
"countyFipsId": "sample String 16",
"creditScore": 17,
"escrowsWaived": true,
"isCashOut": true,
"loanAmount": 20.0,
"loanProductId": "21",
"loanPurpose": "sample String 22",
"lockPeriod": 1,
"miRateTypeId": "1",
"occupancyType": "sample String 23",
"organization": "sample String 24",
"promoCode": "sample String 25",
"propertyTypeId": "26",
"salesPrice": 1.0,
"state": "sample String 27"
}
text/html
{"annualHomeownersInsurance":1.0,"annualPropertyTax":1.0,"callbackUrl":"sample String 1","complete":true,"contactMe":true,"creditReportAuthorizedUrl":"http://webapihelppage4.com","creditReportAuthorizedClientIp":"sample String 5","giftFundsAmount":1.0,"hadBankruptcy":true,"hadForeclosure":true,"hadShortSale":true,"hasRental":true,"hasSecondHome":true,"isBorrowingMoney":true,"monthlyDebtPayment":1.0,"monthlyHOADues":1.0,"monthlyRent":1.0,"netRentalIncome":1.0,"otherTaxesAndInsurances":1.0,"primaryResidenceExpense":1.0,"referralSource":"sample String 11","secondHomePayments":1.0,"securedBorrowedFunds":1.0,"totalLiquidAssets":12.0,"transactionId":"sample String 13","usingGiftFunds":true,"borrowers":[],"countyId":14,"loanOfficerId":1,"appraisedValue":1.0,"corporatePartner":"sample String 15","countyFipsId":"sample String 16","creditScore":17,"escrowsWaived":true,"isCashOut":true,"loanAmount":20.0,"loanProductId":"21","loanPurpose":"sample String 22","lockPeriod":1,"miRateTypeId":"1","occupancyType":"sample String 23","organization":"sample String 24","promoCode":"sample String 25","propertyTypeId":"26","salesPrice":1.0,"state":"sample String 27"}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The pre-qualification results. If a callbackUrl is specified, the results will be sent to the callback URL and a status message will be returned.
QPQResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| appId |
Gets or sets the application identifier. |
integer |
None. |
| appUrl |
Gets or sets the app invite URL. |
URI |
None. |
| date |
Gets or sets the date. |
date |
None. |
| eligibilityConclusions |
Gets or sets the eligibility conclusions. |
Collection of EligibilityConclusion |
None. |
| errors |
Gets or sets the errors. |
Collection of string |
None. |
| letterUrl |
Gets or sets the pre-qualification letter url. |
URI |
None. |
| isQualified |
Gets or sets a value indicating whether the scenario is qualified. |
boolean |
None. |
| rate |
Gets or sets the rate. |
decimal number |
None. |
| transactionId |
Gets or sets the transaction identifier. |
string |
None. |
Response Formats
application/json, text/json
{
"appId": 1,
"appUrl": "http://webapihelppage2.com",
"date": "2025-04-26T01:12:07.5944579Z",
"eligibilityConclusions": [
{
"Message": "sample String 1",
"Details": [],
"Conclusion": "sample String 2"
},
{
"Message": "sample String 1",
"Details": [],
"Conclusion": "sample String 2"
}
],
"errors": [
"sample String 1",
"sample String 2"
],
"letterUrl": "http://webapihelppage4.com",
"isQualified": true,
"rate": 6.0,
"transactionId": "sample String 7"
}
text/html
{"appId":1,"appUrl":"http://webapihelppage2.com","date":"2025-04-26T01:12:07.5944579Z","eligibilityConclusions":[{"Message":"sample String 1","Details":[],"Conclusion":"sample String 2"},{"Message":"sample String 1","Details":[],"Conclusion":"sample String 2"}],"errors":["sample String 1","sample String 2"],"letterUrl":"http://webapihelppage4.com","isQualified":true,"rate":6.0,"transactionId":"sample String 7"}