V3 Manage Additional Loans

patch

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

Use this API to manage the Additional Loans 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 Additional Loans
update to update existing Additional Loans in the application
reorder to swap the order of the existing Additional Loans in the application
delete to delete Additional Loans 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 VOALs need to be retrieved..

Query Params

action

string

Action to be performed. Possible values are: add, update, reorder, delete.

Body Params

string

System-generated, unique identifier of additional loans in the loan.

borrowerType

string

Borrower Type. Possible Values are:
Borrower, Coborrower, Both

holderName

string

Name of the Additional Loans holder.

attention

string

Person's name or department.

holderAddressStreetLine1

string

Street Line 1 of the Additional Loans holder's address.

holderAddressCity

string

City of the Additional Loans holder's address.

holderAddressState

string

State of the Additional Loans holder's address.

holderAddressPostalCode

string

Postal Code of the Additional Loans holder's address.

holderPhone

string

Phone Number of the Additional Loans holder.

holderFax

string

Fax Number of the Additional Loans holder.

holderEmail

string

Email Address of the Additional Loans holder.

printUserNameIndicator

boolean

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

titlePhone

string

Phone Number of the user verifying the Additional Loans.

titleFax

string

Fax number of the user verifying the Additional Loans.

additionalLoanRequestDate

string

Additional Loans Request Date.

printAttachmentIndicator

boolean

Indicates if the attachment is to be printed.

printUserJobTitleIndicator

boolean

Job Title of the user verifying the Additional Loans.

accountType

string

Account Type.

lienPosition

string

Lien Position. Possible Values are: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10.

monthlyPrincipalAndInterest

number

Additional Loans Monthly Principal and Interest.

maximumPrincipalAndInterestIn5Years

number

Additional Loans Maximum Principal and Interest within 5 Years.

helocCreditLimitAmount

number

Additional Loans : Loan Amount/HELOC Credit Limit.

helocInitialDraw

number

Additional Loans HELOC Initial Draw.

amountAppliedToDownpayment

number

Additional Loans Amount Applied To Downpayment.

paymentDeferredFirstFiveYears

boolean

Additional Loans Payment Deferred First Five Years.

affordableLoan

boolean

Additional Loans Affordable Loan Indicator.

linkedPiggybackIndicator

boolean

Additional Loans Linked Piggyback Indicator.

monthlyPiNoteRate

number

Additional Loans calculator : MonthlyPINoteRate.

monthlyPiTerm

integer

Additional Loans MonthlyPITerm.

monthlyPiLoanAmount

number

Additional Loans MonthlyPILoanAmount.

maximumPiNoteRate

number

Additional Loans : MaximumPINoteRate.

maximumPiTerm

integer

Additional Loans MaximumPITerm.

maximumPiLoanAmount

number

Additional Loans MaximumPILoanAmount.

individualCreditorIndicator

boolean

Indicates if the Creditor is an individual Indicator.

sourceOfFunds

string

Source Of Funds. Possible Values are:
CommunityNonprofit
Employer
FederalAgency
Institutional
Lender
LocalAgency
Other
NonParentRelative
Parent
Relative
ReligiousNonprofit
StateAgency
UnrelatedFriend
UnmarriedPartner

Headers

Authorization

string

required

Bearer token

Response

Language

URL

Loading…

Response

Choose an example:

application/json

200OK