V3 Manage VOLs

patch

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

This API can be used to manage the Verification of Liabilities 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 VOLs
update to update existing VOLs in the application
reorder to swap the order of the existing VOLs in the application
delete to delete VOL 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 for which VOLs need to be retrieved..

Query Params

action

string

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

Body Params

string

System-generated, unique identifier of the VOL in an application in the loan.

accountIdentifier

string

Account Identifier of the Liability.

attention

string

Attention To.

date

string

Date that the VOL was added.

exclusionIndicator

boolean

Indicates of the VOL should be excluded.

holderAddressCity

string

City of the VOL holder's address.

holderAddressPostalCode

string

Postal Code of the VOL holder's address.

holderAddressState

string

State of the VOL holder's address.

holderAddressStreetLine1

string

Street Line 1 of the VOL holder's address.

holderComments

string

Comments related to the VOL holder.

holderEmail

string

Email Address of the VOL holder.

holderFax

string

Fax Number of the VOL holder.

holderName

string

Name of the VOL holder.

holderPhone

string

Phone Number of the VOL holder.

liabilityType

string

Type of Liability.

monthlyPaymentAmount

number

Monthly Payment Amount.

monthsToExclude

integer

Number of Months to exclude the payment for this Liability..

nameInAccount

string

Name as indicated in the Liability account.

noLinkToDocTrackIndicator

boolean

Indicates if a verification document has been created in the loan for the liability.

owner

string

Owner of the Liability.

payoffStatusIndicator

boolean

Indicates if the liability has been paid off.

prepaymentPenaltyAmount

number

Prepayment Penalty Amount.

printAttachmentIndicator

boolean

Indicates if the attachment is to be printed.

remainingTermMonths

integer

Number of months remaining on the Liability's term.

reoProperty

string

Linked REO Property.

subjectLoanResubordinationIndicator

boolean

Subject Loan Resubordination Indicator.

title

string

Title of the user verifying the liability.

titleFax

string

Fax number of the user verifying the liability.

titlePhone

string

Phone Number of the user verifying the liability.

toBePaidOffAmount

number

Amount that needs to be paid off.

unpaidBalanceAmount

string

Unpaid balance amount on the liability.

descriptionOfPurpose

string

Purpose Description.

isDebtNotSecuredToSubjectPropertyIndicator

boolean

Indicates if debt is not secured to the subject property.

ucdPayoffType

string

Type of UCD Payoff.

payoffIncludedIndicator

boolean

Indicates if the pay off included.

printUserNameIndicator

boolean

Indicates if the user's name is to be printed.

printUserJobTitleIndicator

boolean

Job Title of the user verifying the liability.

lates12Month30Day

integer

Number of 12 month 30 Day late payments.

lates24Month30Day

string

Number of 24 month 30 Day late payments.

lates25Month30Day

string

Number of 25 month 30 Day late payments.

lates12Month60Day

string

Number of 12 month 60 Day late payments.

lates24Month60Day

string

Number of 24 month 60 Day late payments.

lates25Month60Day

string

Number of 25 month 60 Day late payments.

lates12Month90Day

string

Number of 12 month 90 Day late payments.

lates24Month90Day

string

Number of 24 month 90 Day late payments.

lates25Month90Day

string

Number of 25 month 90 Day late payments.

lates12Month120Day

string

Number of 12 month 120 Day late payments.

lates24Month120Day

string

Number of 24 month 120 Day late payments.

lates25Month120Day

string

Number of 25 month 120 Day late payments.

lates12Month150Day

string

Number of 12 month 150 Day late payments.

lates24Month150Day

string

Number of 24 month 150 Day late payments.

lates25Month150Day

string

Number of 25 month 150 Day late payments.

subjectPropertyIndicator

boolean

Subject Property Indicator.

currentLienPosition

string

Current Lien Position.

proposedLienPosition

string

Current Lien Position.

bankLiabilityConsideredIndicator

boolean

Indicates if the bank considers this entry as a liability.

creditLimit

number

Credit Limit

includeTaxesAndInsuranceIndicator

boolean

Indicates if this is included for tax and insurance purposes.

mortgageType

string

Mortgage Type.

otherDescription

string

Description if the liability is of any other type.

foreignAddressIndicator

boolean

Indicates of the Liability is in a foreign address.

country

string

Country of liability.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

Language

URL

Loading…

Response

Choose an example:

application/json

200OK