V3 Manage VODs

patch

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

This API can be used to manage the Verification of Deposits 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 VODs
update to update existing VODs in the application
reorder to swap the order of the existing VODs in the application
delete to delete VOD 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 VODs need to be retrieved..

Query Params

action

string

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

Body Params

string

System-generated, Unique identifier of the VOD entry in the collection.

attention

string

Attention to.

depositoryRequestDate

string

Request Date of the deposit.

holderAddressCity

string

Deposit holder's Address City.

holderAddressPostalCode

string

Deposit holder's Postal Code.

holderAddressState

string

Deposit holder's Address State.

holderAddressStreetLine1

string

Deposit holder's Address Line 1.

holderComments

string

Comments for the Deposit Holder.

holderEmail

string

Deposit holder's email address.

holderFax

string

Deposit holder's Fax number.

holderName

string

Deposit holder's Name.

holderPhone

string

Deposit holder's Phone Number.

includeInAusExport

boolean

Indicator if the AUS export should include this VOD.

noLinkToDocTrackIndicator

boolean

Read-only. Indicates if there is a linked Verification Document created in the loan for this VOD.

owner

string

Owner of the VOD. Possible Values are borrower and coborrower.

printAttachmentIndicator

boolean

Indicates if the 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.

title

string

Title of the user who is verifying the deposit.

titleFax

string

Fax Number of the user who is verifying the deposit.

titlePhone

string

Phone number of the user who is verifying the deposit.

total

number

Total amount of VOD.

foreignAddressIndicator

boolean

Indicates if the VOD address is located in a foreign country.

country

string

Country of VOD.

items

array

List of Items included in the VOD.

items

item.itemNumber

integer

Number of the item under the VOD.

item.type

string

Type of Line Item for the VOD. Example: Checking Account.

item.accountIdentifier

string

Account Identifier for the VOD Line Item.

item.cashOrMarketValueAmount

number

Cash or Market Value the VOD Line Item.

item.urla2020CashOrMarketValueAmount

number

Account Identifier for the VOD Line Item used for URLA 2020 Loans.

item.depositoryAccountName

string

Account Depositor Name for the VOD Line Item.

item.foreignAddressIndicator

boolean

Indicates if the Item is in a foreign country.

item.country

string

Country of line item deposit.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

Language

URL

Response

Choose an example:

application/json

200OK