V3 Manage Enhanced Condition Types

Add, update, or delete enhanced condition types.

Query Params
string

Action to be performed on the condition type. Possible values are Add, Update, and Delete.

string

Specifies the type ID to reassign to when templateOption is ReAssign.

string

Possible values are:
Delete - To delete (cascade) condition type ID.
Reassign - To reassign to a different condition type ID. Must specify reassignToTypeId.

string

Optional. View type parameter. Enumerations: detail, full, summary
When no view parameter is provided, the API will return 204 - No Content with no response body.

Body Params
string

Unique identifier of the condition, which is guaranteed to be unique. For example:
"3AA5BF62-3C0D-46A7-8ADE-03907BE0A5E5"
When you specify a condition in a call, you provide the condition ID. The condition ID can be retrieved from the response header when the condition is created.

string

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

string

Title or name of the condition. For example, "Income - Personal Tax Returns".

NOTE: At the loan-level, this attribute is RetrieveOnly and cannot be edited.

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."

printDefinitions
array of strings

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

printDefinitions
string

The external identifier of the condition that will be displayed to TPO Users. Should be alphanumeric, no special characters to be 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 source system that created the condition. For example, "Fannie Mae".

application
object

Identifies the borrower pair associated with this condition.

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:

  • 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. Example values are:

  • Approval
  • Docs
  • Funding
  • Closing
  • Purchase
string

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

string

Identifies the date the condition takes effect. For example, 2019-11-24T04:14:30Z

string

Identifies the date that the condition is no longer required. For example, 2019-12-24T04:14:30Z

string

Identifies the person or entity that the condition is requested from. For example, "Borrower"

integer

Number of days the condition is expected to be received.

string

RetrieveOnly. Name of the current status type of the condition. For example, "Requested"

string

RetrieveOnly. Date and time that the current status was applied (should be stored in GMT timezone). For example, 2019-11-24T04:14:30Z.

boolean

RetrieveOnly. Indicates whether the condition is open or satisfied based on the definition. Read-only.

string

RetrieveOnly. Total number of comments for the condition.

assignedTo
array of objects

List of documents that the condition is assigned to.

assignedTo
createdBy
object

The Entity Reference contract describing the user or role who created the condition or document.

string

Date and time the condition was created. For example, 2019-11-24T04:14:30Z

lastModifiedBy
object

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

string

RetrieveOnly. Date and time the condition was last modified. For example, 2019-11-24T04:14:30Z

boolean

Indicates whether the condition has been removed from the loan.

tracking
array of objects
tracking
comments
array of objects
comments
definitions
object

The Enhanced Condition Definition contract.

string

The source of condition is populated at the time when the enhanced condition is added. The following are available values:

  • User
  • Manual
  • ConditionList
  • AutomatedByUser
  • FHA
  • DUFindings
  • EarlyCheckFindings
  • LPAFindings
  • FHA Findings
  • LCLAFindings
  • Duplicate - Duplicate is always set internally when Condition is created with action=duplicate. This is a readOnly attribute for users of Encompass Developer Connect.
  • InvestorDelivery (Service-to-Service only)
  • AutomatedByRule (Service-to-Service only)
  • PartnerConnect (Service-to-Service only)
Headers
string
required

Bearer token.

Responses
200

OK

400

Bad Request

403

Forbidden

Language
URL