Update Loan Opportunity

patch

https://api.elliemae.com/loanOpportunity/v1/loanOpportunities/{opportunityId}

Updates the specified loan opportunity.

Path Params

opportunityId

string

required

Required. Unique identifier of the opportunity to be retrieved.

Body Params

borrowers

array of objects

required

Required. A list of borrowers for the Opportunity. BorrowerContract.

borrowers*

dateCreated

date-time

The date and time the Opportunity was created.

dateModified

date-time

The date and time the Opportunity was last modified.

dateStatusUpdated

date-time

Date when the qualification status was last updated.

documentTrackingLogs

array of objects

A list of DocumentTrackingLogs for the Opportunity. DocumentTrackingLogContract.

documentTrackingLogs

documents

array of objects

A list of Documents for the Opportunity.
DocumentContract.

documents

estimatedCreditScore

int32

Estimated credit score.

firstTimeHomebuyer

boolean

Indicates whether the borrower is a first-time homebuyer.

string

The unique, system-generated identifier of this opportunity.

loanId

string

The unique identifier of the loan.

loanInfo

object

Loan information provided by the LoanInfoContract.

loanNumber

string

The number assigned to the loan.

loanReferenceId

string

The ID to bind the entity in the loan.

purchaseCredits

array of objects

A list of purchase credits for the Opportunity.
Includes information from the PurchaseCreditContract.

purchaseCredits

qualificationStatus

string

The qualification status of any Scenario in the Opportunity.

scenarioCount

int32

Scenario count for the opportunity.

source

string

Source.

subjectProperty

object

Information about the subject property as provided by the PropertyContract.

subordinateFinancing

double

Subordinate Financing.

totalAssets

double

The total sum of assets for all borrowers.

totalBankDeposit

double

Assets Total Bank Deposits.

totalCurrentHousingPayment

double

The total sum of housing expenses for all borrowers.

totalExpenses

double

The total sum of expenses for all borrowers.

totalIncome

double

The sum of all borrowers total income.

totalScenarioCount

int32

Total scenario count for the opportunity, including deleted scenarios.

veteranStatus

string

Veteran status.

Headers

Authorization

string

required

Bearer token

Responses

202

Accepted

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

URL