V1 Move Borrower Pair

patch

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

Swaps the position of borrower pairs in a loan.

Note that the altIds of the borrower and co-borrower do not change on the applications.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

Query Params

view

string

Optional. View type parameter. Enumerations: entity, id
When no view parameter is provided, the API will return 204 - No Content with no response body.

Body Params

string

entityDeleted

boolean

accountNumber1

string

accountNumber2

string

allOtherPaymentsAmount

number

applicationId

string

applicationIndex

integer

applicationSignedDate

string

assets

array of objects

assets

giftsGrants

array of objects

giftsGrants

otherIncomeSources

array of objects

otherIncomeSources

assetsAvailableAmount

number

balanceAvailableFamilySupportGuideline

number

borrower

object

bottomRatioPercent

number

brwCoBrwTotalTaxDeductions

number

coborrower

object

creditAliasName1

string

creditAliasName2

string

creditorName1

string

creditorName2

string

creditReportReferenceIdentifier

string

employment

array of objects

employment

equifaxAddress

string

equifaxCity

string

equifaxFax

string

equifaxModel

string

equifaxName

string

equifaxPhone

string

equifaxPostalCode

string

equifaxScoreRangeFrom

string

equifaxScoreRangeTo

string

equifaxState

string

equifaxWebsite

string

experianAddress

string

experianCity

string

experianFax

string

experianModel

string

experianName

string

experianPhone

string

experianPostalCode

string

experianScoreRangeFrom

string

experianScoreRangeTo

string

experianState

string

experianWebsite

string

fhaVaDebtIncomeRatio

number

fhaVaFamilySupportAmount

number

fhaVaTotalEstimatedMonthlyShelterExpenseAmount

number

fhaVaTotalNetEffectiveIncomeAmount

number

fhaVaTotalNetIncomeAmount

number

fhaVaTotalNetTakeHomePayAmount

number

fhaVaTotalOtherNetIncome

number

firstMortgagePrincipalAndInterestAmount

number

freddieMacCreditReportReferenceIdentifier

string

freddieMacOccupantHousingRatio

number

freddieMacOccupantDebtRatio

number

freDebtToHousingGapRatio

number

grossBaseIncomeAmount

number

grossIncomeForComortSet

number

grossNegativeCashFlow

number

grossOtherIncomeAmount

number

grossPositiveCashFlow

number

hazardInsuranceAmount

string

homeownersAssociationDuesAndCondoFeesAmount

string

hudAutoLienHolderName1

string

hudAutoLienHolderName2

string

hudAutoLoanAmount1

number

hudAutoLoanAmount2

number

hudAutoMonthlyPayment1

number

hudAutoMonthlyPayment2

number

hudAutoPresentBalance1

number

hudAutoPresentBalance2

number

hudAutoYearAndMake1

string

hudAutoYearAndMake2

string

hudLoanAmount1

number

hudLoanAmount10

number

hudLoanAmount11

number

hudLoanAmount2

number

hudLoanAmount3

number

hudLoanAmount4

number

hudLoanAmount5

number

hudLoanAmount6

number

hudLoanAmount7

number

hudLoanAmount8

number

hudLoanAmount9

number

hudRealEstateFhaInsured1

boolean

hudRealEstateFhaInsured2

boolean

hudRealEstateLienHolder1

string

hudRealEstateLienHolder2

string

hudRealEstateLoanAmount1

number

hudRealEstateLoanAmount2

number

hudRealEstateMonthlyPayment1

number

hudRealEstateMonthlyPayment2

number

hudRealEstatePresentBalance1

number

hudRealEstatePresentBalance2

number

income

array of objects

income

incomeOfBorrowersSpouseUsedIndicator

boolean

incomeOtherThanBorrowerUsedIndicator

boolean

jointAssetLiabilityReportingIndicator

boolean

liabilities

array of objects

liabilities

liquidAssetsComortSet

number

mcawBorrowerOtherMonthlyIncomeAmount

number

mcawCoborrowerOtherMonthlyIncomeAmount

number

mcawGrossMonthlyIncomeAmount

number

mcawMortgagePaymentToIncome1Amount

number

mcawMortgagePaymentToIncome2Amount

number

mcawOtherAmount

number

mcawOtherDebtsAndObligationsAmount

number

mcawTotalFixedPaymentForPurchaseAmount

number

mcawTotalFixedPaymentForRefinanceAmount

number

mcawTotalFixedPaymentToIncome1Amount

number

mcawTotalFixedPaymentToIncome2Amount

number

mcawTotalMonthlyPaymentsAmount

number

mcawTotalMortgagePaymentAmount

number

monthlyExpenseComortSet

number

monthlyHousingExpenseAmount

number

monthlyInstallmentExpenseAmount

number

monthlyNegativeRealEstateAmount

number

monthlySecondHomeAmount

number

mortgageInsuranceAmount

string

netWorthAmount

number

otherHousingExpenseAmount

number

otherItemsDeducted

number

otherMortgagePrincipalAndInterestAmount

number

pastCreditRecord

string

presentHousingExpComortSet

number

primaryResidenceComortSet

number

propertyUsageType

string

proposedDuesAmount

string

proposedFirstMortgageAmount

number

proposedGroundRentAmount

number

proposedHazardInsuranceAmount

string

proposedMortgageInsuranceAmount

string

proposedOtherAmount

number

proposedOtherMortgagesAmount

number

proposedRealEstateTaxesAmount

string

realEstateTaxAmount

string

rentAmount

number

reoProperties

array of objects

reoProperties

reoTotalGrossRentalIncomeAmount

number

reoTotalMaintenanceAmount

number

reoTotalMarketValueAmount

number

reoTotalMortgagePaymentsAmount

number

reoTotalMortgagesAndLiensAmount

number

reoTotalNetRentalIncomeAmount

integer

residences

array of objects

residences

otherAssets

array of objects

otherAssets

otherLiabilities

array of objects

otherLiabilities

providedDocuments

array of objects

providedDocuments

fannieIncomeCalculators

array of objects

fannieIncomeCalculators

repWarrantTrackers

array of objects

repWarrantTrackers

additionalLoans

array of objects

additionalLoans

selfEmployedIncomes

array of objects

selfEmployedIncomes

spouseIncomeConsider

boolean

tax4506s

array of objects

tax4506s

topRatioPercent

number

totalAssetsAmount

number

totalBaseIncomeAmount

number

totalBonusAmount

number

totalCommissionsAmount

number

totalDeposit

number

totalDividendsInterestAmount

number

totalEmploymentAmount

number

totalFixedPaymentAmount

number

totalGrossMonthlyIncomeAmount

number

totalIncomeAmount

number

totalMonthlyPaymentAmount

number

totalMortgagesBalanceAmount

number

totalMortgagesMonthlyPaymentAmount

number

totalNetRentalIncomeAmount

number

totalOther1Amount

number

totalOther2Amount

number

totalOvertimeAmount

number

totalPaymentsAmount

number

totalPrimaryHousingExpenseAmount

number

supplementalInsuranceAmount

number

totalReoMarketValueAmount

number

totalUserDefinedIncome

number

tQLReports

array of objects

tQLReports

transUnionAddress

string

transUnionCity

string

transUnionFax

string

transUnionModel

string

transUnionName

string

transUnionPhone

string

transUnionPostalCode

string

transUnionScoreRangeFrom

string

transUnionScoreRangeTo

string

transUnionState

string

transUnionWebsite

string

userDefinedIncome

number

userDefinedIncomeDescription

string

vACreditStandards

string

vaSummarySpouseIncomeAmount

number

vaSummaryTotalMonthlyGrossIncomeAmount

number

aTRQMBorrower

object

sofDBorrowerAddressType

string

sofDBorrowerAddress

string

sofDBorrowerAddressCity

string

sofDBorrowerAddressState

string

sofDBorrowerAddressZipcode

string

sofDCoBorrowerAddressType

string

sofDCoBorrowerAddress

string

sofDCoBorrowerAddressCity

string

sofDCoBorrowerAddressState

string

sofDCoBorrowerAddressZipcode

string

sofDBorrCountry

string

sofDCoBorrCountry

string

sofDBorrForeignAddressIndicator

boolean

sofDCoBorrForeignAddressIndicator

boolean

aUSTrackingLogs

array of objects

aUSTrackingLogs

aTRQMBorrowers

array of objects

aTRQMBorrowers

loanOfficerId

string

loanOfficerName

string

lastModified

string

respa6

string

loanAmount

string

uRLAAlternateNames

array of objects

uRLAAlternateNames

totalAdditionalAssetsAmount

number

totalURLA2020AssetsAmount

number

totalAdditionalOtherAssetsAmount

number

totalOtherAssetsAmount

number

otherTotalIncome

number

totalAdditionalLoansAmount

number

totalAppliedToDownpayment

number

borrowerPairId

string

closingDisclosureBorDeliveryDate

string

closingDisclosureBorReceivedDate

string

loanEstimateDeliveryDate

string

rescissionDate

string

rescissionNoteSignedDate

string

presentSupplementalPropertyInsuranceAmount

number

prequalCreditReportIndicator

boolean

preApprovalCreditReport

boolean

signingMode

string

notifyOnReceiptIndicator

boolean

notifyWhenNotReceivedDate

string

fulfillmentEnabledIndicator

boolean

scheduledFulfillmentDate

string

Headers

Authorization

string

required

Bearer token

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL