HELOC Inquiries/Offers
Select an offer
PUT
/products /heloc /v1 /inquiry /{appUuid} /select-offerRequest
Path parameters
appUuidstringRequired
Request body
application/jsonrequestobjectRequiredShowHide 2 attributes of request
loanOriginatorUuidstringRequiredasyncbooleanRequiredDeprecatedWill be removed from all requests in a future release. This is no longer an option on some requests. Async will be the only option.
offerobjectRequiredShowHide 4 attributes of offer
offerUuidstringRequiredselectedOfferAmountnumberRequiredselectedDiscountsarray of stringsRequiredselectedAccountsToPayoffarray of stringsRequired
suppressCompletionbooleanRequired
Responses
200OKobject
messagesarray of objectsShowHide 2 attributes of messages
levelstringRequiredmessagestringRequired
appDetailsobjectShowHide 7 attributes of appDetails
organizationstringRequiredappUuidstring<uuid>RequiredappDataobjectRequiredShowHide 31 attributes of appData
isInquirybooleanRequiredisBridgeLoanbooleanRequiredstartedAsInquirybooleanRequiredautopaybooleanRequiredstatusstringRequiredoverallStatusstringRequirednextInquiryStepenumOne of17 values
UNKNOWNNO_OFFERSREFINANCE_OFFEROFFERS_AVAILABLEOFFER_SELECTION_PENDINGBORROWER_AUTH_REQUIREDBROKER_DOC_SIGNING_REQUIREDINQUIRY_COMPLETEINQUIRY_CLOSEDINQUIRY_WITHDRAWNCREDIT_MATCH_REQUIREDMORE_ASSETS_REQUIREDLIEN_MATCHING_REQUIREDPROPERTY_VALUE_REQUIREDPAYOFF_REQUIREDUNFREEZE_CREDITSELECT_PROPERTYkeyDatesobjectShowHide 12 attributes of keyDates
createdDatestring<date-time>expirationDatestring<date-time>rescissionEndDatestring<date-time>signingDatestring<date-time>completedDatestring<date-time>canceledDatestring<date-time>declinedDatestring<date-time>summaryDisclosureDatestring<date-time>productAgreementESignedTimestampstring<date-time>firstPaymentDueDatestring<date-time>expectedPayoffDatestring<date-time>lastStatusUpdateDatestring<date-time>
propertyAddressobjectShowHide 5 attributes of propertyAddress
street1stringRequiredPattern^[a-zA-Z0-9\s\-\.']+$citystringRequiredPattern^[a-zA-Z\s\-']+$statestringRequiredPattern^[A-Z]{2}$zipstringRequiredPattern^[0-9]{5}(?:-[0-9]{4})?$street2stringPattern^[a-zA-Z0-9\s\-\.']+$
statusReasonsarray of stringsownershipTypeenumOne ofUNKNOWNSOLEJOINTTRUSTLLCOTHERfinancingPurposeenumOne of13 values
UNKNOWNDEBT_CONSOLIDATIONHOME_IMPROVEMENTMAJOR_PURCHASETRAVELEDUCATIONHEALTH_MEDICALCARING_FOR_FAMILYRETIREMENTSMALL_BUSINESSHOME_IMPROVEMENT_SMALL_BUSINESSSOLAR_ENERGY_EFFICIENT_INSTALLATIONOTHERpropertyLiensarray of objectsShowHide 7 attributes of propertyLiens
lienUuidstring<uuid>RequiredoriginationDatestringlenderNamestringoriginalBalancenumbercurrentBalancenumbermonthlyPaymentnumberlienPositioninteger<int32>
hudLiensarray of objectsShowHide 7 attributes of hudLiens
lienUuidstring<uuid>RequiredoriginationDatestringlenderNamestringoriginalBalancenumbercurrentBalancenumbermonthlyPaymentnumberlienPositioninteger<int32>
underwritingobjectShowHide 26 attributes of underwriting
decisionstringminOfferAmountnumbermaxOfferAmountnumberminOfferRatenumbermaxOfferRatenumberofeeMaxThresholdnumberoffersarray of objectsShowHide 11 attributes of offers
uuidstring<uuid>RequiredminAmountnumberRequiredmaxAmountnumberRequiredratenumberRequiredprimeRatenumberRequiredterminteger<int32>RequiredrateTypeenumRequiredOne ofUNKNOWNFIXEDVARIABLEoriginationFeePercentnumberRequireddiscountsarray of objectsShowHide 2 attributes of discounts
typestringRequiredrateDiscountAmountnumberRequired
preDiscountOriginationFeenumberappliedOriginationFeeCapAmountnumber
selectedOfferobjectShowHide 13 attributes of selectedOffer
offerUuidstring<uuid>RequiredloanAmountnumberRequireddrawAmountnumberRequiredestimatedMonthlyPaymentnumberRequiredratenumberRequiredprimeRatenumberRequiredterminteger<int32>RequiredrateTypeenumRequiredOne ofUNKNOWNFIXEDVARIABLEoriginationFeePercentnumberRequiredoriginationFeenumberRequiredDeprecateduse originationFeePercent instead
selectedDiscountsarray of objectsShowHide 2 attributes of selectedDiscounts
typestringRequiredrateDiscountAmountnumberRequired
creditLinenumberoriginationFeeAmountnumber
softCreditobjectShowHide 3 attributes of softCredit
providerenumOne ofEXPERIANTRANS_UNIONscoreinteger<int32>timestampstring<date-time>
hardCreditobjectShowHide 3 attributes of hardCredit
providerenumOne ofEXPERIANTRANS_UNIONscoreinteger<int32>timestampstring<date-time>
monthlyIncomenumberstatedMonthlyIncomenumberpreLoanDtinumberpostLoanDtinumberstatedDtinumbercoDeedStatusenumOne ofINITIALIN_PROGRESSCOMPLETEfloodInsuredbooleanhomeownersInsuredbooleanemploymentTypestringhomeForSaleMlsResponsebooleanhomeForSaleBorrowerAttestedbooleancreditAsOfDatestring<date>pricingAsOfDatestring<date>guidelineVersionstringfinalAvmFsdinteger<int32>prequalFsdinteger<int32>
propertyValueobjectShowHide 7 attributes of propertyValue
borrowerEstimatedValuenumberpropertyAvmValuenumberpreLoanCltvnumberpostLoanCltvnumberpreLoanAdjCltvnumberpostLoanAdjCltvnumberpostLoanAdjMinCltvnumber
manualNotaryobjectDeprecateduse notary instead
ShowHide 2 attributes of manualNotary
manualNotaryDatestring<date-time>manualNotaryFeenumber
notaryobjectShowHide 4 attributes of notary
typeenumOne ofNOT_APPLICABLEELECTRONICMANUALfeenumberappointmentDatestring<date-time>completedDatestring<date-time>
costsobjectShowHide 3 attributes of costs
fixedCostsarray of objectsShowHide 2 attributes of fixedCosts
typeenumRequiredOne ofNOTARY_FEERECORDING_TAXRECORDING_FEETITLE_FEEBPO_FEEDRIVE_BY_VALUATION_FEEONSITE_APPRAISAL_FEEborrowerPaidAmountnumber
dynamicCostsarray of objectsShowHide 2 attributes of dynamicCosts
typeenumRequiredOne ofNOTARY_FEERECORDING_TAXRECORDING_FEETITLE_FEEBPO_FEEDRIVE_BY_VALUATION_FEEONSITE_APPRAISAL_FEEborrowerPaidAmountnumber
totalPaidByBorrowernumber
ddpDetailsobjectShowHide 6 attributes of ddpDetails
paidLiabilityPayoffAmountnumbertotalLiabilityPayoffAmountnumberliabilityPayoffAllocatedAmountDtiImpactingnumberliabilityPayoffAllocatedAmountNonDtiImpactingnumberlienPositionAfterPayoffinteger<int32>existingLiabilitiesobjectShowHide 2 attributes of existingLiabilities
eligiblearray of objectsRequiredShowHide 15 attributes of eligible
idstringRequiredmonetaryBalancenumberRequiredcreditorNamestringRequiredprovidesDtiCreditbooleanRequiredprovidesCltvCreditbooleanRequiredprovidesLienPositionCreditbooleanRequiredrateTypeenumOne ofVARIABLEFIXEDliabilitySubTypeenumOne of12 values
LEASELOAN_SUB_TYPEFEDERALPRIVATEHELOCLINE_OF_CREDITFLEXIBLE_SPENDINGCHARGESECUREDUNSECUREDPURCHASEBUSINESSlastDigitsOfAccountNumberstringinterestRatePercentagenumberinterestRatePercentageMaxnumberinterestRatePercentageMinnumberpayOffStatusenumOne ofMARKED_FOR_PAYOFFPAID_OFFPAYOFF_REQUESTEDPAYOFF_FAILEDPAYOFF_REVERSALPAYOFF_REVERSAL_PROCESSINGliabilityTypeenumOne ofAUTOPERSONALFIGURE_SERVICING_HELOCHOME_IMPROVEMENTCREDIT_CARDMORTGAGEHELOCreasonsarray of objectsShowHide 2 attributes of reasons
unavailableReasonenumOne of15 values
NO_MATCHED_TRADELINENO_MATCHED_LIENNO_STATE_ELIGIBILITYABOVE_MAXIMUM_BALANCEEXCLUDED_BY_CREDIT_SCOREEXCLUDED_BY_CHARGED_OFF_ACCOUNTEXCLUDED_BY_CREDIT_CARD_TOTAL_ACCOUNT_DTIEXCLUDED_BY_NEXT_MIN_PAYMENTEXCLUDED_BY_MONETARY_BALANCEEXCLUDED_BY_MONETARY_ORIGINAL_LOAN_AMOUNTEXCLUDED_BY_PAYMENT_CAPABILITYEXCLUDED_BY_SUBSCRIPTION_CAPABILITYEXCLUDED_BY_SENSITIVE_ACCOUNT_CAPABILITYSEASONING_REQUIREMENTS_NOT_METOTHERdescriptionstring
ineligiblearray of objectsRequiredShowHide 15 attributes of ineligible
idstringRequiredmonetaryBalancenumberRequiredcreditorNamestringRequiredprovidesDtiCreditbooleanRequiredprovidesCltvCreditbooleanRequiredprovidesLienPositionCreditbooleanRequiredrateTypeenumOne ofVARIABLEFIXEDliabilitySubTypeenumOne of12 values
LEASELOAN_SUB_TYPEFEDERALPRIVATEHELOCLINE_OF_CREDITFLEXIBLE_SPENDINGCHARGESECUREDUNSECUREDPURCHASEBUSINESSlastDigitsOfAccountNumberstringinterestRatePercentagenumberinterestRatePercentageMaxnumberinterestRatePercentageMinnumberpayOffStatusenumOne ofMARKED_FOR_PAYOFFPAID_OFFPAYOFF_REQUESTEDPAYOFF_FAILEDPAYOFF_REVERSALPAYOFF_REVERSAL_PROCESSINGliabilityTypeenumOne ofAUTOPERSONALFIGURE_SERVICING_HELOCHOME_IMPROVEMENTCREDIT_CARDMORTGAGEHELOCreasonsarray of objectsShowHide 2 attributes of reasons
unavailableReasonenumOne of15 values
NO_MATCHED_TRADELINENO_MATCHED_LIENNO_STATE_ELIGIBILITYABOVE_MAXIMUM_BALANCEEXCLUDED_BY_CREDIT_SCOREEXCLUDED_BY_CHARGED_OFF_ACCOUNTEXCLUDED_BY_CREDIT_CARD_TOTAL_ACCOUNT_DTIEXCLUDED_BY_NEXT_MIN_PAYMENTEXCLUDED_BY_MONETARY_BALANCEEXCLUDED_BY_MONETARY_ORIGINAL_LOAN_AMOUNTEXCLUDED_BY_PAYMENT_CAPABILITYEXCLUDED_BY_SUBSCRIPTION_CAPABILITYEXCLUDED_BY_SENSITIVE_ACCOUNT_CAPABILITYSEASONING_REQUIREMENTS_NOT_METOTHERdescriptionstring
utmParametersobjectShowHide 5 attributes of utmParameters
sourcestringmediumstringcampaignstringcontentstringtermstring
statusHistoryarray of objectsShowHide 3 attributes of statusHistory
overallStatusstringRequiredstatusstringRequiredtimestampstring<date-time>
propertyDetailsobjectShowHide 10 attributes of propertyDetails
countystringpropertyTypeenumOne ofPRIMARYSECONDARYINVESTMENTpropertyUuidstring<uuid>corelogicPropertyIdstringlotSquareFeetinteger<int32>propertyFloodZonestringlandUseDescriptionstringlandUseCodestringbuildingGrossAreanumberpropertyAcresnumber
borrowerDetailsobjectShowHide 2 attributes of borrowerDetails
primaryobjectRequiredShowHide 10 attributes of primary
identityUuidstring<uuid>emailstringfirstNamestringmiddleNamestringlastNamestringsuffixstringprefixstringdobstring<date>addressobjectShowHide 5 attributes of address
street1stringRequiredPattern^[a-zA-Z0-9\s\-\.']+$citystringRequiredPattern^[a-zA-Z\s\-']+$statestringRequiredPattern^[A-Z]{2}$zipstringRequiredPattern^[0-9]{5}(?:-[0-9]{4})?$street2stringPattern^[a-zA-Z0-9\s\-\.']+$
phoneNumberstring
additionalSignersarray of objectsShowHide 10 attributes of additionalSigners
identityUuidstring<uuid>emailstringfirstNamestringmiddleNamestringlastNamestringsuffixstringprefixstringdobstring<date>addressobjectShowHide 5 attributes of address
street1stringRequiredPattern^[a-zA-Z0-9\s\-\.']+$citystringRequiredPattern^[a-zA-Z\s\-']+$statestringRequiredPattern^[A-Z]{2}$zipstringRequiredPattern^[0-9]{5}(?:-[0-9]{4})?$street2stringPattern^[a-zA-Z0-9\s\-\.']+$
phoneNumberstring
assignedUsersarray of objectsShowHide 1 attribute of assignedUsers
userUuidstring<uuid>Required
conditionsarray of objectsShowHide 4 attributes of conditions
activebooleanRequirednamestringRequiredcreatedDatestring<date-time>lastUpdateDatestring<date-time>
demographicsobjectShowHide 16 attributes of demographics
hispanicOrLatinoEthnicityTypebooleanethnicityRefusalbooleanotherEthnicityDescriptionstringgenderRefusalbooleanraceRefusalbooleanraceAsianAdditionalDescriptionstringracePacificIslanderAdditionalDescriptionstringethnicityCollectedBasedOnVisualObservationOrSurnamebooleangenderCollectedBasedOnVisualObservationOrNamebooleanraceCollectedBasedOnVisualObservationOrSurnamebooleantribeNamestringnotHispanicOrLatinobooleanethnicityOriginTypesarray of enumsOne ofCUBANMEXICANPUERTO_RICANOTHERgenderTypesarray of enumsOne ofBOTH_MALE_AND_FEMALEFEMALEMALEraceTypesarray of enumsOne ofAMERICAN_INDIAN_OR_ALASKA_NATIVEASIANBLACK_OR_AFRICAN_AMERICANNATIVE_HAWAIIAN_OR_OTHER_ISLANDERWHITEraceDesignationTypesarray of enumsOne of11 values
ASIAN_INDIANCHINESEFILIPINOGUAMANIAN_OR_CHAMORROJAPANESEKOREANNATIVE_HAWAIIANOTHER_ASIANOTHER_PACIFIC_ISLANDERSAMOANVIETNAMESE
thirdPartyIntegrationsobjectShowHide 3 attributes of thirdPartyIntegrations
externalPartnerApplicationIdstringexternalPartnerReferenceIdstringexternalPartnerCustomerIdstring
fundingTransactionReportobjectShowHide 1 attribute of fundingTransactionReport
transactionsarray of objectsShowHide 9 attributes of transactions
idstringamountnumberinitiatedAtstring<date-time>effectiveDatestringpaymentRailenumOne ofACHWIREstatusenumOne ofPENDINGSENTCOMPLETECANCELLEDEXCEPTIONRETURNEDNOCREQUIRES_APPROVALREJECTEDmessageUuidstring<uuid>sentAtstring<date-time>batchingCategorystring
businessInfoobjectShowHide 7 attributes of businessInfo
entityNamestringRequiredentityTypeenumRequiredOne ofSOLE_PROPRIETORSHIPSINGLE_OWNER_LLCPARTNERSHIPMULTI_OWNER_LLCS_CORPPARTNERSHIP_OR_LLCownershipPercentagenumbertotalMonthlyRevenuenumbereinstringstateOfIncorporationstringaddressobjectShowHide 5 attributes of address
street1stringRequiredPattern^[a-zA-Z0-9\s\-\.']+$citystringRequiredPattern^[a-zA-Z\s\-']+$statestringRequiredPattern^[A-Z]{2}$zipstringRequiredPattern^[0-9]{5}(?:-[0-9]{4})?$street2stringPattern^[a-zA-Z0-9\s\-\.']+$
authorizedSignatoryobjectShowHide 2 attributes of authorizedSignatory
authorizedSignatoryNamestringauthorizedSignatoryDatestring<date>
testVariantsobjectRequiredShowHide 1 attribute of testVariants
variantsarray of objectsRequiredShowHide 1 attribute of variants
namestringRequired
appShortIdstringborrowerAppLinkstringloanOriginatorDataobjectShowHide 8 attributes of loanOriginatorData
loanOriginatorUuidstring<uuid>brokerUuidstring<uuid>externalIdstringnmlsstringcompanyNmlsstringlicensesobjectShowHide 3 attributes of licenses
lenderLicenseobjectShowHide 2 attributes of lenderLicense
licenseHolderobjectShowHide 4 attributes of licenseHolder
typeenumRequiredOne ofUNKNOWNLENDERBROKERLOAN_OFFICERuuidstring<uuid>Requirednamestringnmlsstring
stateLicenseobjectShowHide 5 attributes of stateLicense
typeenumRequiredOne ofUNKNOWNUNSPECIFIEDFEDERAL_LICENSECA_RMLA_STATE_LICENSECA_CFL_STATE_LICENSECA_DRE_STATE_LICENSEuuidstring<uuid>RequiredlicenseNumberstringlicenseNamestringstatestring
loanOriginatorLicenseobjectShowHide 2 attributes of loanOriginatorLicense
licenseHolderobjectShowHide 4 attributes of licenseHolder
typeenumRequiredOne ofUNKNOWNLENDERBROKERLOAN_OFFICERuuidstring<uuid>Requirednamestringnmlsstring
stateLicenseobjectShowHide 5 attributes of stateLicense
typeenumRequiredOne ofUNKNOWNUNSPECIFIEDFEDERAL_LICENSECA_RMLA_STATE_LICENSECA_CFL_STATE_LICENSECA_DRE_STATE_LICENSEuuidstring<uuid>RequiredlicenseNumberstringlicenseNamestringstatestring
brokerLicenseobjectShowHide 2 attributes of brokerLicense
licenseHolderobjectShowHide 4 attributes of licenseHolder
typeenumRequiredOne ofUNKNOWNLENDERBROKERLOAN_OFFICERuuidstring<uuid>Requirednamestringnmlsstring
stateLicenseobjectShowHide 5 attributes of stateLicense
typeenumRequiredOne ofUNKNOWNUNSPECIFIEDFEDERAL_LICENSECA_RMLA_STATE_LICENSECA_CFL_STATE_LICENSECA_DRE_STATE_LICENSEuuidstring<uuid>RequiredlicenseNumberstringlicenseNamestringstatestring
companyDbaNamestringemailstring
Response
PUT
/products /heloc /v1 /inquiry /{appUuid} /select-offerResponse