V3 Manage Enhanced Condition Templates

Add, update, or remove enhanced condition templates from the Encompass instance.

Query Params
string

Action to be performed on the condition template. Possible values are Add, Update, and Remove.

Body Params
string

Unique identifier of the condition. For example:
"3AA5BF62-3C0D-46A7-8ADE-03907BE0A5E5"

string

Condition name.

string

Identifies the type of condition. For example, Preliminary, Underwriting, Post-Closing, etc. The value is obtained from the Enhanced Condition template.

string

Indicates whether the condition type is active.

string

The internal identifier of the condition that will be displayed to Encompass Web users. Alphanumeric, no special characters. For example, "INC0001"

string

The internal description of the condition that will be displayed to Encompass Web users. For example, "Collect signed and dated returns with all pages and schedules."

string

The external identifier of the condition that will be displayed to TPO Users. Must be alphanumeric. No special characters
allowed.

string

The external description of the condition that will be displayed to TPO users. For example, "Provide signed and dated tax returns with all pages and schedules."

string

Identifies the category associated with the condition. Values are defined within Encompass settings and can vary between lenders and investors.
Some example values are the following:

  • Assets
  • Credit
  • Income
  • Legal
  • Misc
  • Property
string

Identifies when the condition is required to be cleared or waived. Values are defined within Encompass settings and can vary between lenders and investors. Some example values are the following:

  • Approval
  • Docs
  • Funding
  • Closing
  • Purchase
integer

Number of days the condition is expected to be received.

owner
object

Object containing the Encompass Role responsible for satisfying the condition.

boolean

Indicates whether the condition type is customized.

printDefinitions
array of strings

Indicates whether the condition should be printed on internal and/or external documents.
Possible values: InternalPrint, ExternalPrint

printDefinitions
boolean

Indicates whether conditions can be duplicated in the loan.

string

Recipient of the condition. For example, "MERS".
Values are defined within Encompass settings and can vary between lenders and investors.

string

The source the condition may come from.

date-time

Identifies the date the condition takes effect. For example, 2022-01-20T16:43:41.645Z

date-time

Identifies the date that the condition is no longer required. For example, 2022-01-20T16:43:41.645Z

customDefinitions
object

Custom definitions for the condition type.

assignedTo
object

List of document templates that the condition template is assigned to.

date-time

Date and time the condition was created. For example, 2022-01-20T16:43:41.655Z.

createdBy
object

The entity reference contract describing the user or role who created the condition or document.

date-time

RetrieveOnly. Date and time the condition was last modified. For example, 2022-01-20T16:43:41.655Z.

lastModifiedBy
object

RetrieveOnly. Information about the last modification made to the condition.

Headers
string
required

Bearer token.

Responses
200

OK

400

Bad Request

403

Forbidden

Language
URL
LoadingLoading…