V3 Contracts

📘

As a general guideline for all V3 APIs, send date/datetime fields only in the following ISO formats:

  • date-times: yyyy-MM-ddTHH:mm:ssZ
  • dates: yyyy-MM-dd

Encompass Standard Fields Attributes

The following objects and attributes make up the Encompass Standard Fields object. All attributes are optional unless otherwise specified.

ATTRIBUTEDESCRIPTION
id
string
The Encompass field ID that is mapped to the field name.
description
string
Description of the Encompass field.
format
string
Data format of the field. Possible values are:

STRING, YN, X, ZIPCODE, STATE, PHONE, SSN, INTEGER, DECIMAL_1, DECIMAL_2, DECIMAL_3, DECIMAL_4, DECIMAL_5, DECIMAL_6, DECIMAL_7, DECIMAL_10, DECIMAL, RA_STRING, RA_INTEGER, RA_DECIMAL_2, RA_DECIMAL_3, MONTHDAY, DATE, DATETIME, DROPDOWNLIST, DROPDOWN, AUDIT, COMMENT, and UNDEFINED.
readOnly
boolean
Indicates whether the field is editable.
nullable
boolean
Indicates whether the field is Nullable.
category
string
The field category. Possible values are:
Borrower - if the field is under Borrower entity
Coborrower - if the field is under Coborrower entity
* Common - if the field is outside of borrower and coborrower entities
maxLength
integer
The maximum length allowed for the field.
multiInstance
boolean
Indicates whether the field is repeatable within the entity.
Options
Array[FieldOptionContract]
Values depend on the field type.
domainPath
string
Domain Path of the field.
contractPath
string
Contract path of the field ID. For example loan.baseLoanAmount
jsonPath
string
JSON path of the field in the loan object. For example $.baseLoanAmount.
entitiesFilterKey
string
Indicates the entity the field ID belongs to in the loan object.

Virtual Field Contract Attributes

The following objects and attributes make up the VirtualFieldContract object.

ATTRIBUTEDESCRIPTION
id
string
The virtual field ID that is mapped to the field name.
description
string
Description of the virtual field.
format
string
Data format of the field. Possible values are:

STRING, YN, X, ZIPCODE, STATE, PHONE, SSN, INTEGER, DECIMAL_1, DECIMAL_2, DECIMAL_3, DECIMAL_4, DECIMAL_5, DECIMAL_6, DECIMAL_7, DECIMAL_10, DECIMAL, RA_STRING, RA_INTEGER, RA_DECIMAL_2, RA_DECIMAL_3, MONTHDAY, DATE, DATETIME, DROPDOWNLIST, DROPDOWN, AUDIT, COMMENT, and UNDEFINED.
multiInstance
boolean
Indicates whether the field is repeatable within the entity.
instanceSpecifierType
string
Type of entity if the virtual field is a multiInstance field. Possible values are:

None, Index, Role, Milestone, Document, UnderwritingCondition, PostClosingCondition, MilestoneTask, CustomAlert, PreliminaryCondition, MilestoneTemplate, and EnhancedCondition.