V3 Manage Residences

patch

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

This API can be used to manage the Residences collection for a borrower or coborrower under an application. You can perform one of these operations in a single transaction on all the entries in this collection:

add to add new Residences records
update to update existing Residences records in the application
reorder to swap the order of the existing Residences records in the application
delete to delete Residences records 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.

applicantType

string

required

Possible values are: borrower and coborrower.

Query Params

action

string

Action to be performed on the applicant's employment collection in a loan application. Possible values are: add, update, reorder, delete.

Body Params

string

System-generated, unique identifier of the Residence Record.

residencyType

string

Type of Residence, Mandatory. Possible values are: Prior, Current.

accountName

string

Name of the Account Holder.

addressCity

string

City of Residence address.

addressPostalCode

string

Postal Code of Residence address.

addressState

string

State of Residence address.

addressStreetLine1

string

Street Line 1 of Residence address.

addressCounty

string

County of Residence address.

addressUnitDesignatorType

string

Unit Designator Type of Residence address.

addressUnitIdentifier

string

Unit Identifier of Residence address.

doesNotApplyIndicator

boolean

Indicates if this residence does not apply.

countryCode

string

Country Code of Residence address.

county

string

County of Residence.

durationTermMonths

integer

Duration of Stay in the residence in months.

durationTermYears

integer

Duration of stay in the residence in years.

landlordAttention

string

Attention to landlord.

landlordCity

string

City of Landlord.

landlordComments

string

Comments of Landlord.

landlordEmail

string

Email Address of Landlord.

landlordFax

string

Fax Number of Landlord.

landlordName

string

Name of Landlord.

landlordPhone

string

Phone number of Landlord.

landlordPostalCode

string

Postal Code of Landlord.

landlordState

string

State of Landlord.

landlordStreet

string

Street Address of Landlord.

noLinkToDocTrackIndicator

boolean

Indicates if a verification document has been added to the loan for this residence.

printAttachmentIndicator

boolean

Indicates if an attachment is to be printed.

printUserJobTitleIndicator

boolean

Indicates if the job title of the user verifying the residence should be printed.

printUserNameIndicator

boolean

Indicates if the name of the user verifying the residence should be printed.

rent

integer

Rent Amount for the residence.

requestDate

string

Request Date.

residencyBasisType

string

Basis Type of Residence.

title

string

Title of the user.

titleFax

string

Fax Number of the user.

titlePhone

string

Phone Number of the user.

urla2020StreetAddress

string

Street Address for an URLA 2020 Address.

landlordCountry

string

Country of the landlord.

landlordForeignAddressIndicator

boolean

Indicates if the Landlord's address is a foreign address.

foreignAddressIndicator

boolean

Indicates if the residence is a foreign one.

country

string

Country of residence.

altId

string

ReadOnly. altId fields are automatically generated by internal services.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

Language

URL

Loading…

Response

Choose an example:

application/json

200OK