Enhanced Conditions API Contracts and Attributes
The following section lists each contract used in the Enhanced Conditions API and describes all the attributes that make up each contract. All attributes are optional unless otherwise specified.
Enhanced Condition Contract
The following objects and attributes make up the EnhancedConditionContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| Id 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. |
| conditionType string | Read-only. Identifies the type of condition. For example, Preliminary, Underwriting, Post-Closing, etc. The value is obtained from the Enhanced Condition template. |
| title string | Title or name of the condition. For example, "Income - Personal Tax Returns". |
| internalId string | The internal identifier of the condition that will be displayed to Encompass Web users. Alphanumeric, no special characters. For example, "INC0001". |
| internalDescription 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" |
| externalId string | The external identifier of the condition that will be displayed to TPO Users. Should be alphanumeric, no special characters to be allowed. |
| externalDescription 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." |
| source string | Identifies the source system that created the condition. For example, "Fannie Mae". |
| application ApplicationReferenceContract | Identifies the borrower pair associated with this condition. See the ApplicationReferenceContract. |
| category 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 |
| priorTo 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 |
| recipient string | Recipient of the condition. For example, "MERS". Values are defined within Encompass settings and can vary between lenders and investors. |
| startDate string | Identifies the date the condition takes effect. For example, 2019-11-24T04:14:30Z |
| endDate string | Identifies the date that the condition is no longer required. For example, 2019-12-24T04:14:30Z |
| requestedFrom string | Identifies the person or entity that the condition is requested from. For example, "Borrower". |
| daysToReceive integer | Number of days the condition is expected to be received. |
| status string | RetrieveOnly. Name of the current status type of the condition. For example, "Requested". |
| statusDate string | RetrieveOnly. Date and time that the current status was applied (should be stored in GMT timezone). For example, 2019-11-24T04:14:30Z. |
| statusOpen boolean | RetrieveOnly. Indicates whether the condition is open or satisfied based on the definition. Read-only. |
| commentsCount integer | RetrieveOnly. Total number of comments for the condition. |
| assignedTo Array[EntityReferenceContract] | List of documents that the condition is assigned to. |
| createdBy entityReferenceContract | The Entity Reference contract describing the user or role who created the condition or document. |
| createdDate string | Date and time the condition was created. For example, 2019-11-24T04:14:30Z |
| lastModifiedBy EntityReferenceContract | RetrieveOnly. Information about the last modification made to the condition. |
| lastModifiedDate string | RetrieveOnly. Date and time the condition was last modified. For example, 2019-11-24T04:14:30Z |
| isRemoved boolean | Indicates whether the condition has been removed from the loan. |
| tracking Array[TrackingEntryContract] | Tracking Event contract. |
| comments Array[LogCommentContract] | Log Comment contract. |
| definitions EnhancedConditionDefinitionContract | The Enhanced Condition Definition contract. |
| sourceOfCondition 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 - InvestorDelivery (Service-to-Service only) - AutomatedByRule (Service-to-Service only) - PartnerConnect (Service-to-Service only)Duplicate: Duplicate is always set internally when Condition is created with action=duplicateThis is a readOnly attribute for users of Encompass Developer Connect. |
Tracking Entry Contract Attributes
The following objects and attributes make up the TrackingEntryContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| status string | Name of the status that was marked as complete. |
| user EntityReferenceContract | The Entity Reference contract describing the user or role who marked the status tracking entry. |
| date string($date-time) | Date and time at which the status was marked as complete. For example, 2022-01-24T22:11:53.648Z |
EnhancedConditionDefinitionsContract
The following objects and attributes make up the EnhancedConditionDefinitionsContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| categoryDefinitions Array[OptionDefinitionContract] | List of the Category field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| priorToDefinitions Array[OptionDefinitionContract] | List of the Prior To field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| recipientDefinitions Array[OptionDefinitionContract] | List of the Recipient field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| sourceDefinitions Array[OptionDefinitionContract] | List of the Source field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| trackingDefinitions Array[TrackingDefinitionContract] | List of the Status Tracking definitions for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the TrackingDefinitionContract. |
Option Definition Contract Attributes
The following objects and attributes make up the OptionDefinitionContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| name string | Name of the option that will be displayed in the list or drop-down. For example, "Fulfilled" |
Tracking Definition Contract Attributes
The following objects and attributes make up the TrackingDefinitionContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| roles EntityReferenceContract | List of roles that have permission to mark or unmark this status tracking entry. See the EntityReferenceContract. |
Log Comment Contract Attributes
The following objects and attributes make up the LogCommentContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Unique ID associated with the comment. Example: "id": "ade11842-a02f-44d7-8554-5dcb7580e676", |
| addedby EntityReferenceContract | Information about the user who added the comment. |
| comments string | Comments associated with the condition. |
| addedDate string($date-time) | RetrieveOnly. Date and time at which the comment was added. For example, 2022-01-24T22:11:53.648Z |
| forRole EntityReferenceContract | The role for which the comment was added. See the EntityReferenceContract. |
| reviewedBy EntityReferenceContract | Information about the user who reviewed the comment. |
| reviewedDate string($date-time) | RetrieveOnly. Date and time at which the comment was reviewed. For example, 2022-01-24T22:11:53.648Z |
| isExternal boolean | Indicates whether the comment can be shown externally. |
Entity Reference Contract Attributes
The following attributes make up the EntityReferenceContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| entityId string | Required. Unique identifier of the entity. |
| entityName string | RetrieveOnly. Name of the entity. |
| entityType string | Possible values are: User Role Condition Application Attachment Document MilestoneSetting Milestone |
Enhanced Conditions Settings Contracts and Attributes
The following section lists each contract used in the Enhanced Condition Settings API and describes all the attributes that make up each contract. All attributes are optional unless otherwise specified.
Enhanced Condition Type Contract Attributes
The following objects and attributes make up the EnhancedConditionTypeContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Unique identifier of the condition, which is guaranteed to be unique. For example: "3AA5BF62-3C0D-46A7-8ADE-03907BE0A5E5" |
| title string | Condition name. |
| active boolean | Indicates whether the condition type is active. |
| definitions EnhancedConditionDefinitionContract | Definitions provided by the EnhancedConditionDefinitionContract. |
| categoryDefinitions OptionDefinitionContract | Category details provided by the OptionDefinitionContract. |
| createdBy EntityReferenceContract | Information about the user who created the condition type. Retrieve only. |
| createdDate string | The date on which the condition type was created. The format is yyyy-MM-ddTHH:mm:ssZ. Retrieve only. |
| lastModifiedBy EntityReferenceContract | Information about the user who last modified the condition type. Retrieve only. |
| lastModifiedDate string | The date the condition type was last modified. The format is yyyy-MM-ddTHH:mm:ssZ. Retrieve only. |
Enhanced Condition Definition Contract Attributes
The following objects and attributes make up the EnhancedConditionDefinitionContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| categoryDefinitions Array[OptionDefinitionContract] | List of the Category field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| priorToDefinitions Array[OptionDefinitionContract] | List of the Prior To field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| recipientDefinitions Array[OptionDefinitionContract] | List of the Recipient field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| sourceDefinitions Array[OptionDefinitionContract] | List of the Source field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| trackingDefinitions Array[TrackingDefinitionContract] | List of the Status Tracking definitions for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the TrackingDefinitionContract. |
Tracking Definition Contract Attributes
The following objects and attributes make up the TrackingDefinitionContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| name string | Name of tracking definition. |
| open boolean | Indicates whether the condition is still open (and not considered closed) when the specific tracking option is selected in the loan file. |
| roles Array[EntityReferenceContract] | EntityReferenceContract describing roles. |
Enhanced Condition Set Contract Attributes
The following objects and attributes make up the enhancedConditionSetContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Unique identifier of the condition, which is guaranteed to be unique. |
| name string | Name of the enhanced condition set. |
| description string | Description of the enhanced condition set. |
| conditions object | Object containing details about each enhanced condition. |
| conditions.id 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. |
| conditions.title string | Title or name of the condition. For example, "Income - Personal Tax Returns". |
| conditions.conditionType string | Identifies the type of condition. For example, Preliminary, Underwriting, Post-Closing, etc. The value is obtained from the Enhanced Condition template. |
| conditions.active boolean | Indicates whether the condition is active. |
| conditions.internalId string | The internal identifier of the condition that will be displayed to Encompass Web users. Alphanumeric, no special characters. For example, "INC0001". |
| conditions.internalDescription 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". |
| conditions.externalId string | The external identifier of the condition that will be displayed to TPO Users. Should be alphanumeric, no special characters to be allowed. |
| conditions.externalDescription 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." |
| conditions.category 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 |
| conditions.priorTo 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 |
| conditions.daysToReceive | Number of days the condition is expected to be received. |
| conditions.customizeTypeDefinition boolean | Indicates whether the condition set type is customized. |
| conditions.printDefinitions Array of strings | Indicates whether the condition should be printed on internal and/ or external documents. Possible values: "InternalPrint", "ExternalPrint" |
| conditions.createdDate | Date and time the condition was created. For example, 2022-01-24T22:11:53.733Z |
| conditions.createdBy entityReferenceContract | The Entity Reference contract describing the user or role who created the condition or document. |
| conditions.lastModifiedDate | Date and time the condition was last modified. For example, 2022-01-24T22:11:53.733Z |
| conditions.lastModifiedBy EntityReferenceContract | Information about the last modification made to the condition. |
Enhanced Condition Template Contract Attributes
The following objects and attributes make up the enhancedConditionTemplateContract object.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Unique identifier of the condition. For example: "3AA5BF62-3C0D-46A7-8ADE-03907BE0A5E5" |
| title string | Condition name. |
| conditionType string | Identifies the type of condition. For example, Preliminary, Underwriting, Post-Closing, etc. The value is obtained from the Enhanced Condition template. |
| active boolean | Indicates whether the condition type is active. |
| internalId string | The internal identifier of the condition that will be displayed to Encompass Web users. Alphanumeric, no special characters. For example, "INC0001". |
| internalDescription 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". |
| externalId string | The external identifier of the condition that will be displayed to TPO Users. Should be alphanumeric, no special characters to be allowed. |
| externalDescription 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." |
| category 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 |
| priorTo 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 |
| daysToReceive integer | Number of days the condition is expected to be received. |
| customizeTypeDefinition 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" |
| allowDuplicate boolean | Indicates whether conditions can be duplicated in the loan. |
| recipient string | Recipient of the condition. For example, "MERS". Values are defined within Encompass settings and can vary between lenders and investors. |
| source string | The source the condition may come from. |
| startDate string | Identifies the date the condition takes effect. For example, 2022-01-20T16:43:41.645Z |
| endDate string | Identifies the date that the condition is no longer required. For example, 2022-01-20T16:43:41.645Z |
| customDefinitions EnhancedConditionDefinitionContract | Custom definitions for the condition type. |
| createdDate string | Date and time the condition was created. For example, 2022-01-20T16:43:41.655Z. |
| createdBy EntityReferenceContract | The Entity Reference contract describing the user or role who created the condition or document. |
| lastModifiedDate string | RetrieveOnly. Date and time the condition was last modified. For example, 2022-01-20T16:43:41.655Z. |
| lastModifiedBy EntityReferenceContract | RetrieveOnly. Information about the last modification made to the condition. |
Custom Definitions Contract Attributes
The following attributes make up the customDefinitions object which contains attributes that describe custom definitions for the condition type.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| categoryDefinitions Array[OptionDefinitionContract] | List of the Category field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| priorToDefinitions Array[OptionDefinitionContract] | List of the Prior To field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| recipientDefinitions Array[OptionDefinitionContract] | List of the Recipient field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| sourceDefinitions Array[OptionDefinitionContract] | List of the Source field options for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the OptionDefinitionContract. |
| trackingDefinitions Array[TrackingDefinitionContract] | List of the Status Tracking definitions for this condition type, condition template, or condition. This field only applies to Enhanced Conditions. See the TrackingDefinitionContract. |
Connect Settings Contract Attributes
The following attributes make up the connectSettings object which contains attributes that describe the TPO Connect settings for the condition template.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| documentTemplate EntityReferenceContract | Reference to the document template if the documentType is Template. |
| documentOption string | Indicates if documents should be created using a predefined document template or just with a matching name of the condition. |
© ICE Mortgage Technology, Inc. All rights reserved.