Apply Plan Code

post

https://api.elliemae.com/encompassdocs/v1/planCodes/{planCodeID}/evaluator

Applies program data from a specified plan code to a loan file. Any plan code conflicts are provided in the response.

Path Params

planCodeID

string

required

The ID of the plan code to import.

Query Params

lockId

string

The loan lock ID to apply to the loan file.

Body Params

entity

object

Required. Entity object containing details about the Plan Code for a loan program that will be applied to a loan file.

orderType

string

The type of order, either opening or closing.

import

string

Indicates how the Plan Code data will be applied to the loan.
Possible values are:

all - Apply all data associated with plan code. The current loan data will be overwritten with the selected plan code data.

planCodeOnly - Apply the plan code data and do not update conflicting loan attributes. Any conflicting data will be retained on the loan.
If import is null and there are no conflicts, all data associated with the plan code will be applied to the loan.
If import is null and there are conflicts, no data will be applied to the loan.

Headers

Authorization

string

required

Bearer token

Responses

409

Conflict

202Accepted