V3 Manage REO Properties

patch

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

This API can be used to manage the REO Properties collection for an application at once. You can perform one of these operations in a single transaction on all the entries in this collection:

add to add new REO Properties
update to update existing REO Properties in the application
reorder to swap the order of the existing REO Properties in the application
delete to delete REO Properties entries from the application

Path Params

loanId

string

required

Unique Identifier of the loan.

applicationId

string

required

Unique identifier of the Application or Borrower Pair in the loan.

Query Params

action

string

Action to be performed on the REO Properties collection in the loan. Possible values are: add, update, reorder, delete.

Body Params

title

string

Title of the user

string

System-generated, unique identifier of the REO property

acquiredDate

string

Date that the property was acquired

city

string

City of the property

countryCode

string

Country code of the property

dispositionStatusType

string

Disposition status type of the property

gsePropertyType

string

GSE property type that this REO Property qualifies as

yearBuilt

string

The year in which the property was built

liabilityDoesNotApply

boolean

Indicates of this is considered as a liability

includeInAusExport

boolean

Indicates if this property should be included during AUS Export

lienInstallmentAmount

number

Lien Installment Amount

lienUpbAmount

number

Lien UPB Amount

maintenanceExpenseAmount

string

Maintenance Expense Amount for the property

marketValueAmount

number

Market Value Amount for the property

noLinkToDocTrackIndicator

boolean

Indicates if there is a verification documents linked to this REO Property in the loan

owner

string

Owner of the REO Property in the borrower pair. Possible values are borrower and coborrower.

participationPercentage

number

Percentage of participation by the owner

percentageofRental

number

Percentage of Rental Amount

postalCode

string

Postal Code of the REO Property

printAttachIndicator

boolean

Indicates if an attachment should be printed

printUserJobTitleIndicator

boolean

Indicates if the User's job title should be printed

printUserNameIndicator

boolean

Indicates if the User's name should be printed

propertyUsageType

string

Usage type of property

purchasePrice

integer

Purchase Price of the property

rentalIncomeGrossAmount

integer

Rental Income Gross Amount

rentalIncomeNetAmount

integer

Rental Income Net Amount

reoComments

string

Comments

requestDate

string

Requested Date

state

string

State of the REO Property

streetAddress

string

Street Address of the REO Property

subjectIndicator

string

Indicates if this is the subject property

titleFax

string

Fax of the user

titlePhone

string

Phone Number of the user

unitNumber

string

Unit Number of the REO Property

unitType

string

Unit Type of the REO Property

urla2020StreetAddress

string

Street Address as indicated in the URLA 2020 form

numberOfUnits

string

Number of units in the property

futurePropertyUsageType

string

Property usage type in the future. Possible values are: PrimaryResidence, SecondHome,

futureUsageTypeOtherDesc

string

Description of the property usage type in the future if other

foreignAddressIndicator

string

Indicates if the property is located in a foreign country

country

string

Country of the REO Property

Headers

Authorization

string

required

Bearer token

Response

Language

URL

Loading…

Response

Choose an example:

application/json

200OK