V3 Update Loan

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}

Updates an existing loan. This API also supports the application of loan program templates.

🚧
No validation errors are returned for non-editable option fields (e.g., field 19 "Loan Purpose Type"). If an invalid value is provided, this API will clear the existing value in the field and will not return an error. This behavior will be enhanced in a future release.

Sample Response

Click here to view the example response (PDF)

Usage Note

The "preview" parameter enables you to retrieve a preview of the loan response, using the request payload provided, without saving and committing data to the loan. To view the results of the operation, you must send both the "view" and "preview" parameters. For the view parameter, use the value applicable to your use case. You can follow up with a subsequent PATCH loan call with the same request payload, and this parameter set to “false’ or not provided, to save and commit the changes to the loan.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

Query Params

lockId

string

Lock ID used to lock loan.

action

string

Action to be performed on the loan while updating the loan. Possible values are:
- tpoRegister - Register a TPO loan. Submit Date (TPO.X4) should be blank.
- tpoSubmit - To submit a loan to TPO. Registration Date (TPO.X3) cannot be blank.
- tpoResubmit - To resubmit a loan to TPO. Registration Date (TPO.X3) cannot be blank.
- tpoOrderAppraisal - To update the appraisal ordered date for a loan (TPO.X117).
- tpoGenerateDisclosures - To update the LE or Disclosures generated date for a loan (TPO.X116).
- updateCorrespondentBalance - To update the correspondent balance on the loan. Same as the Update Balances button in the Encompass Purchase Advice screen.
- updateCorrespondentFees - To update the correspondent fees on the loan. Same as the Update Fees button in the Encompass Purchase Advice screen.

entities

string

Comma-separated list of loan entities to retrieve from the loan.

templateType

string

Type of the template being added. Supported template types are:
- AffiliatedBusinessArrangement
- ClosingCost
- Funding
- Investor
- LoanProgram
- SettlementServiceProvider
- TemplateSet
- TemplateType

templatePath

string

Path of the template needed to be applied. Must use templateType param when providing the template path.

ignoreEmptyLoanProgramValues

boolean

Indicates whether or not to ignore blank template values for the loan program template.

ignoreEmptyLoanProgramClosingCostValues

boolean

Indicates whether or not to ignore empty fields on the Closing Cost Template when being applied from Loan program template.

ignoreEmptyClosingCostValues

boolean

Indicates whether or not to ignore empty closing cost data when applying a Closing Cost template.

includeEmpty

boolean

Specify true to include fields and objects that are empty.

includeRemoved

boolean

Indicates to include records removed from entities.

view

string

Optional. View type parameter. Enumerations: entity, full, id, logs
When no view parameter is provided, the API will return 204 - No Content with no response body.
For more details, see About Loan Views.

preview

boolean

Defaults to false

Indicate true to retrieve a preview of the loan response without saving and committing the data. Default is false.
- All loan calculations will run.
- No email notifications will generate.
- No new version of the loan file will be created.
- No webhooks will be triggered.
- No new snapshots will be created.
- No deferred loan processes will occur.
- No updates will occur to fields dependent on loan save (e.g. loan alerts)
Note: You can follow up with a subsequent PATCH loan call with the same request payload, and this parameter set to “false’ or not provided, to save and commit the changes to the loan.

Body Params

string

loanIdNumber

string

additionalRequests

object

adverseActionDate

string

affiliatedBusinessArrangements

array of objects

affiliatedBusinessArrangements

agencyCaseIdentifier

string

alertChangeCircumstances

array of objects

alertChangeCircumstances

alterationsImprovementsOrRepairsAmount

number

applications

array of objects

applications

applicationTakenMethodType

string

aprDisclosureDate

string

armTypeDescription

string

atrqmCommon

object

baseLoanAmount

number

belowMarketSubordinateFinancingIndicator

boolean

billingCategory

string

biweeklyPaymentAmount

number

bltv

integer

borrowerCoBorrowerMarriedIndicator

boolean

borrowerCount

string

borrowerPaidClosingCostsAmount

number

borrowerPaidDiscountPointsAmount

number

borrowerPaidFhavaClosingCostsAmount

number

borrowerPairCount

integer

tpoMigrationDone

boolean

borrowerRequestedLoanAmount

number

borrowerRequestedLoanAmountUrla

number

brokerPaidClosingCostsAmount

number

buydownIndicator

boolean

buydownMonthlyPaymentAmount

number

buydownRatePercent

number

calculatedDrawAmount

number

calculatedLoanAmount

number

cashFromToBorrowerAmount

number

channel

string

closingBillingDate

string

closingCost

object

closingCostProgram

string

closingCostsAndPrepaidsFromOtherLienAmount

number

closingCostsPaidByOthersAmount

number

closingDocsStackingOrder

string

closingDocument

object

collateralManagerScore

integer

combinedLtv

number

commitmentNumber

string

commitmentTerms

object

complianceTestLogs

array of objects

complianceTestLogs

conformingJumbo

string

constructionManagement

object

consumerConnectSiteId

string

consumerHomeInsuranceOrderEligible

boolean

contacts

array of objects

contacts

contactUpdatedIndicator

boolean

contractSellerCreditAmount

number

conversationLogs

array of objects

conversationLogs

copyBrokerToLenderIndicator

boolean

copyLoanNumLenderCaseNum

string

correspondent

object

creditScoreToUse

string

currentApplicationIndex

integer

currentApplicationIsPrimary

boolean

currentFirstMortgageHolderType

string

customFields

array of objects

customFields

customModelFields

object

deductOverwireAmountIndicator

boolean

disableESignConsentAlert

boolean

disableKeyPricingAlert

boolean

disclosureNotices

object

disclosureTrackingLogs

array of objects

disclosureTrackingLogs

disclosureTracking2015Logs

array of objects

disclosureTracking2015Logs

discountPoint

number

docEngine

string

doNotCheckEmail

string

doNotPrintCompensationFees

boolean

downloadLogs

array of objects

downloadLogs

downPaymentPercent

number

downPayment

object

eDeliveryVersion

integer

edmLogs

array of objects

edmLogs

loCompensation

object

emailTriggerLogs

array of objects

emailTriggerLogs

emDocument

object

emDocumentInvestor

object

emDocumentLender

object

encompassVersion

string

enforceCountyLoanLimit

boolean

emXmlVersionId

string

estimatedClosingCostsAmount

number

estimatedConstructionInterest

number

estimatedPrepaidItemsAmount

number

existingLiensAndDrawUsed

number

existingLiensUsed

number

exportLoanNumber

string

fannieMae

object

fees

array of objects

fees

analyzers

array of objects

analyzers

fhaMiPremiumRefundAmount

number

fhaVaLoan

object

fhavaLoanOriginatorIdentifier

string

fieldLockData

array of objects

fieldLockData

firstAdjustmentMinimum

number

firstSubordinateLienAmount

number

firstTimeHomebuyersIndicator

boolean

fnmCommunityLendingProductName

string

fnmCommunitySecondsIndicator

boolean

fnmNeighborsMortgageEligibilityIndicator

boolean

forms

array of objects

forms

fraudScore

integer

freddieMac

object

funding

object

fundingDeductionList

string

fundingFeeList

string

fundingFees

array of objects

fundingFees

gfe

object

goodFaithFeeVarianceCureLogs

array of objects

goodFaithFeeVarianceCureLogs

governmentLoanLenderIdentifier

string

governmentLoanSponsorIdentifier

string

governmentMortgageCreditCertificateAmount

number

hasAbusinessRelationshipWith

string

hcltvHtltv

number

helocTeaserRate

number

hmda

object

homeCounselingProviders

array of objects

homeCounselingProviders

homeCounselingProvidersServiceNames

string

homeCounselingProvidersLanguageNames

string

homeCounselingProvidersDistance

string

householdSizeCount

integer

hud1Es

object

hudIncomeLimitAdjustmentFactor

number

hudLendingIncomeLimitAmount

number

hudLoanData

object

hudMedianIncomeAmount

number

includeUsdaFeeInClosing

boolean

initialInterestRate

number

initialInterestRateUi

string

insuranceAuthorizationIndicator

string

interimServicing

object

interviewerApplicationSignedDate

string

interviewerEmail

string

interviewerLicenseIdentifier

string

interviewerPhoneNumber

string

interviewersCompanyStateLicense

string

interviewersId

string

interviewerName

string

isCreditorProhibitsBorrower

boolean

isEmployeeLoan

boolean

isLsSecondaryFile

boolean

isRequiredInterestReserveCompoundInterest

boolean

landIfAcquiredSeparatelyAmount

number

leadSource

string

leadSourceId

string

lenderCaseIdentifier

string

lenderChannel

string

lenderCreditsInFunding

number

lenderInvestorCode

string

lenderPaidClosignCostsDotAmount

number

lenderPaidClosingCostsAmount

number

lesserAppraisedValueOrSalesPrice

number

lifeInsuranceCoverageAmount

number

lifeInsuranceEstimatedMonthlyAmount

number

lifeInsuranceTotalProtectedMonthlyAmount

number

linkedBorrowerRequestedLoanAmount

number

loanActionLogs

array of objects

loanActionLogs

linkId

string

loanAmortizationTermMonths

integer

loanAmortizationType

string

loanCreationDate

string

loanImportStatusIndicator

boolean

loanLinkSyncType

string

loanNumber

string

loanProductData

object

loanProgramName

string

loanPrograms

array of objects

loanPrograms

propertyValuations

array of objects

propertyValuations

specialFeatureCodes

array of objects

specialFeatureCodes

loanPurposeOfRefinanceType

string

loanSource

string

loanSubmission

object

loanTotalProposedMonthlyMaintenanceAmount

number

loanTotalProposedMonthlyUtilitiesAmount

number

loanUnderwriterChumsIdentifier

string

loanVaLoanProcedureType

string

loanVaRateReductionInitialComputationTotalAmount

number

loanVaResidualIncomeAmount

number

lockConfirms

array of objects

lockConfirms

lockDenials

array of objects

lockDenials

lockRequests

array of objects

lockRequests

logEntryLogs

array of objects

logEntryLogs

ltv

number

ltvPropertyValue

number

masterCommitmentNumber

string

maturityDate

string

maxBackRatio

number

maxFrontRatio

number

mcaw

object

mersNumber

string

mersNumberRegistrationDate

string

miAndFundingFeeFinancedAmount

number

miAndFundingFeeTotalAmount

number

milestoneApprovedDate

string

milestoneApprovedDueDate

string

milestoneCompletedDate

string

milestoneCompletedDueDate

string

milestoneCurrentDate

string

milestoneCurrentName

string

milestoneNextName

string

milestoneDocSignedDate

string

milestoneDocSignedDueDate

string

milestoneDuration

integer

milestoneFileStartedDate

string

milestoneFreeRoles

array of objects

milestoneFreeRoles

milestoneFundedDate

string

milestoneFundedDueDate

string

milestoneHistoryLogs

array of objects

milestoneHistoryLogs

milestones

array of objects

milestones

milestoneProcessedDate

string

milestoneStage

string

milestoneSubmittedDate

string

milestoneSubmittedDueDate

string

milestoneTasks

array of objects

milestoneTasks

milestoneTemplateLogs

array of objects

milestoneTemplateLogs

documentOrders

array of objects

documentOrders

mipBorrowerPaidInCashAmount

number

mipPaidInCashAmount

number

miscellaneous

object

monthlyPiPaymentAmountForLe1andCd1

number

mortgageInsurancePremiumFhaRefundAmount

number

mortgageInsurancePremiumUpfrontFactorPercent

number

mortgageType

string

msaIdentifier

string

netTangibleBenefit

object

newFirstMortgageAmount

number

newHelocCreditorName

string

newHelocMonthlyPayment

number

newMortgageCreditorName

string

newMortgageMonthlyPayment

number

newSubordinateCreditorName

string

newSubordinateMonthlyPayment

number

nmlsLoanOriginatorId

string

noClosingCostOption

boolean

nonBorrowingOwners

array of objects

nonBorrowingOwners

nonVols

array of objects

nonVols

investorDeliveryLogs

array of objects

investorDeliveryLogs

encompassToEncompassLogs

array of objects

encompassToEncompassLogs

freddieAimChecks

array of objects

freddieAimChecks

priceConcessions

array of objects

priceConcessions

disasters

array of objects

disasters

notRequiredForPurchaseSaleOrRefinance

boolean

notRequiredForSettlementOfYourLoan

boolean

occupancyType

string

openingDocsInvestorCode

string

openingDocsLoanProgramType

string

openingDocsPlanDescription

string

openingDocsPlanId

string

openingDocsProgramCode

string

openingDocsStackingOrder

string

organizationCode

string

originationDate

string

originatorAddressLineText

string

paymentDeferredFirstFiveYears

boolean

affordableLoan

boolean

totalAdditionalMortgages

number

originatorAddressUnitDesignatorType

string

originatorAddressUnitIdentifier

string

originatorFirstName

string

originatorLastName

string

originatorMiddleName

string

originatorSuffixName

string

otherAmortizationTypeDescription

string

otherMortgageTypeDescription

string

otherPaidClosingCostsAmount

number

overwireAmount

number

paymentScheduleCalcRequiredIndicator

boolean

percentageOfOwnership

string

percentageOwnershipInterest

number

pmiIndicator

boolean

postClosingConditions

array of objects

postClosingConditions

preliminaryConditions

array of objects

preliminaryConditions

prequalification

object

principalAndInterestMonthlyPaymentAmount

number

print2003Application

string

printLogs

array of objects

printLogs

printUliOnUrla

boolean

privacyPolicy

object

profitManagement

object

property

object

propertyAppraisedValueAmount

integer

propertyEnergyEfficientHomeIndicator

boolean

propertyEstimatedValueAmount

integer

proposedDuesAmount

string

proposedFirstMortgageAmount

number

proposedGroundRentAmount

number

proposedHazardInsuranceAmount

string

proposedMortgageInsuranceAmount

string

proposedOtherAmount

number

proposedOtherMortgagesAmount

number

proposedRealEstateTaxesAmount

string

purchaseCredits

array of objects

purchaseCredits

purchasePriceAmount

number

rateLock

object

rateLocks

array of objects

rateLocks

referralAddress

string

referralCity

string

referralFeeAmount

number

referralPostalCode

string

referralSource

string

referralState

string

refinanceIncludingDebtsToBePaidOffAmount

number

registrationLogs

array of objects

registrationLogs

regulationZ

object

rentalEstimatedNetMonthlyRentAmount

number

rentalIncomeSectionIndicator

boolean

repurchaseCostAmount

number

repurchaseDate

string

requestedInterestRatePercent

number

requestedInterestRatePercentUi

string

salesConcessionAmount

number

secondSubordinateAmount

number

section32

object

selectedHomeCounselingProvider

object

sectionOfActType

string

sellerPaidClosingCostsAmount

number

serviceProviderAdditionalInfo

string

serviceProviderContacts

array of objects

serviceProviderContacts

serviceProviderDateIssued

string

servicingDisclosure

object

setForSettlementServicesOfAnAttorney

boolean

setForTheSettlementServicesListed

boolean

settlementServiceCharges

array of objects

settlementServiceCharges

shipping

object

simpleRefinanceType

boolean

startingAdjPrice

number

startingAdjRate

number

stateDisclosure

object

statementCreditDenial

object

statusOnlineLogs

array of objects

statusOnlineLogs

subjectPropertyGrossRentalIncomeAmount

number

subjectPropertyOccupancyPercent

number

subordinateLienAmount

number

systemIdGuid

string

targetCltv

number

targetHcltv

number

tilApplicationDate

string

titleHolderName1

string

titleHolderName2

string

tltv

number

totalClosingCostsAmount

number

totalDeductionsAmount

number

totalFeesCostAmount

number

totalFeesCreditAmount

number

totalNonborrowerPaidClosingCostsAmount

number

totalPaidOutsideClosingAmount

number

totalPaidToBrokerAmount

number

totalWireTransferAmount

number

tpo

object

tql

object

trustAccount

object

tsum

object

twelveMonthMortgageRentalHistoryIndicator

boolean

ucdFnmaCasefileStatusType

string

ucdFnmaCasefileWarningIndicator

string

ucdLoanClsMatchStatusType

string

ucdOrigSubmissionDate

string

ucdSubmissionDate

string

uldd

object

underwriterSummary

object

underwritingConditions

array of objects

underwritingConditions

underwritingEscrowIndicator

boolean

undiscountedRate

number

urlaLoanIdentifier

string

urlPage4Comments

string

usda

object

usdaGovernmentLoanType

string

use2018DiIndicator

boolean

useNewHudIndicator

boolean

useNew2015FormsIndicator

string

vaEntitlementAmount

number

vaLoanData

object

valuationUsed

number

virtualFields

object

websiteId

string

alertChangeCircumstanceApplyLecd

string

serverDateTimeDdmApplied

string

proposedHousingExpenseTotal

number

unimprovedEstimatedValue

integer

unimprovedAppraisedValue

integer

closedEndPrimaryMortgageLoanAmount

number

closedEndSubordinateMortgageLoanAmount

number

ucdCaseFileId

string

collateralTracking

object

borrCommunityPropertyStateResidentIndicator

boolean

communityPropertyStateResidentIndicator

boolean

conversionOfContractForDeedIndicator

boolean

renovationLoanIndicator

boolean

constructionLoanIndicator

boolean

constructionToPermanentClosingType

string

propertyExistingCleanEnergyLienIndicator

boolean

titleWillBeFullName

string

titleHolderFullName

string

relationshipVestingType

string

relationshipVestingTypeOtherDescription

string

trustClassificationType

string

nativeAmericanLandsType

string

nativeAmericanLandsTypeOtherDescription

string

productDescription

string

supplementalPropertyInsuranceAmount

number

totalNonSubjectPropertyDebtsToBePaidOffAmount

number

borrEstimatedClosingCostsAmount

number

totalSubordinateFinancingAmount

number

urlaTotalMortgageLoansAmount

number

urlaTotalOtherCreditsAmount

number

totalOfGiftsGrants

number

totalOtherAssetToLoan

number

urlaTotalCreditsAmount

number

housingCounselingAgency

string

ownershipCompletedDate

string

borrowerFullName

string

housingCounselingAgencyFullName

string

counselingCompletedDate

string

counselingBorrowerFullName

string

refinanceCashOutDeterminationType

string

governmentRefinanceType

string

governmentRefinanceTypeOtherDescription

string

projectLegalStructureType

string

condominiumIndicator

boolean

cooperativeIndicator

boolean

pudIndicator

boolean

notInProjectIndicator

boolean

printLenderPages

boolean

lotAcquiredDate

string

additionalLoanDoesNotApply

boolean

printUliAndLoanNoUrla

boolean

negativeAmortization

boolean

prepaymentPenaltyTerm

boolean

temporaryOrInitialInterestRateBuydown

boolean

loanFeaturesOtherIndicator

boolean

temporaryBuydown

string

expectedBorrowerCount

integer

useEnhancedConditionIndicator

boolean

workFlowId

string

complianceReviewType

boolean

mersOrgId

string

mom

boolean

settlementAgentDisbursedFundsDate

string

enoteLenderName

string

enoteMersMinNumber

string

enoteRegisteredDateTime

string

enoteAuthoritativeCopy

boolean

enoteControllerOrgId

string

enoteControllerOrgName

string

enoteLocationOrgId

string

enoteLocationOrgName

string

enoteMasterServiceOrgId

string

enoteMasterServiceOrgName

string

enoteSubservicerOrgId

string

enoteSubservicerOrgName

string

enoteSecuredPartyOrgId

string

enoteSecuredPartyOrgName

string

enoteSecuredPartyDelagateeOrgId

string

enoteSecuredPartyDelagateeOrgName

string

enoteDelagateeForTransferOrgId

string

enoteDelagateeForTransferOrgName

string

enoteTransferEffectiveDate

string

enoteTransferStatus

string

isLoanAmountRounding

boolean

energyImprovementAmount

number

paceLoanPayoffAmount

number

conditions

array of objects

conditions

documents

array of objects

documents

aiq

object

eClose

object

averageRepresentativeCreditScore

integer

averageRepresentativeCreditScoreNotApplicable

boolean

newVestingNboAlert

boolean

nonSpecificLenderCredit

number

nonSpecificSellerCredit

number

useItemizedCredits

boolean

fhaHudReoTotalAmount

number

armIndexPrecision

string

communityLandTrustLessorName

string

disasterDeclared

boolean

affordableHousingEligibleIndicator

boolean

affordableHousingPurchasePriceLimit

number

affordableHousingAreaMedianIncomeYear

integer

affordableHousingAreaMedianIncome80Perc

number

affordableHousingAreaMedianIncome50Perc

number

sendToThirdPartyIndicator

boolean

affordableHousingAreaMedianIncomePercent

integer

affordableHousingAreaMedianIncomeLimit

number

affordableHousingAreaMedianIncomeManualYear

boolean

affordableHousingMedianFamilyIncomeManualYear

boolean

threeDayReadyForDisclosureDate

string

atLockReadyForDisclosureDate

string

atApplicationReadyForDisclosureDate

string

changeCircumstanceReadyForDisclosureDate

string

archived

boolean

msaName

string

actualMfiYear

integer

estimatedMfiYear

integer

actualMfiHundredPercent

number

estimatedMfiHundredPercent

number

incomeImportDate

string

miRateQuoteId

string

miProductDescription

string

pricingProvider

string

analyzerOverallExpirationDate

string

businessAssociationExceptionCount

integer

businessAssociationExceptionIndicator

boolean

dataMappingExceptionIndicator

boolean

assessedValue

integer

uspsAddressDateTimeValidated

string

uspsAddressValidationIndicator

boolean

uspsValidatedStreetAddress

string

uspsValidatedCity

string

uspsValidatedState

string

uspsValidatedZip

string

nonHelocQualifyingPayment

number

assetImportDate

string

creditImportDate

string

submittedToProcessingDate

string

closingDocumentsReceivedDate

string

shipperReviewDate

string

auditAnalyzerImportDate

string

ecoaEarliestClosingDate

string

ecoaMessage

string

priceConcessionCollectionId

string

priceConcessionAmount

number

priceConcessionRequestDatetime

string

priceConcessionRequestBy

string

priceConcessionReason

string

priceConcessionRequestType

string

priceConcessionReviewStatus

string

priceConcessionReviewDatetime

string

priceConcessionReviewBy

string

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK