V3 Contracts

Contracts and Attributes

The following objects and attributes make up the EnhancedDisclosureTracking2015LogContract object. When passing the EnhancedDisclosureTracking2015LogContract object, all attributes are optional unless otherwise specified.

Enhanced Disclosure Tracking 2015 Log Contract

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the Disclosure Tracking 2015 log.
provider string	Indicates whether the service provider responsible for creating and maintaining the record is within the Encompass platform (Encompass Consumer Connect) or is an external provider. Possible values are: - Encompass: Indicates the provider is within the Encompass platform (via Encompass Consumer Connect). - Other: Indicates the provider is outside of the Encompass platform.By default, the service provider is identified as Other. This attribute is applicable to ServiceToServiceOnly and CreateOnly.
providerDescription string	Name of the service provider responsible for creating and maintaining the record.
contents Arraydata": {	List of key documents associated with the record. This attribute is for CreateOnly. Possible values are: - LE - CD - ServiceProviderList - ServiceProviderListNoFee - SafeHarborThe following applies to both Provider types (Encompass and Other): - The contents attribute identifies whether the package contains a Loan Estimate or Closing Disclosure. - The timing and prior number of disclosure records with Loan Estimate or Closing Disclosure will be used to calculate whether the record is an Initial or Revised record.
includedInTimeline boolean	Indicates whether to include the Closing Disclosure in the Disclosure Tracking timeline. The default is true. This attribute is for Create and Update.
status string	Possible values are: - Active - PendingApplicable to ServiceToServiceOnly.
disclosureType string	Type of disclosure. Possible values are: - Initial - Revised - Final - PostConsummation
disclosedDate DisclosedDateFieldContract	The date and time in UTC the disclosure was created.
disclosedBy LockableUserRefFieldContract	Information about the Encompass user who locked and sent the disclosure to the borrower.
disclosedMethod string	The method by which the borrower received the disclosure. Possible values are: - ByMail - Fax - InPerson - Email - Phone - Signature - Other
disclosedMethodDescription string	Description of Other, if the disclosedMethod is Other.
intentToProceed IntentToProceedContract	Object containing information related to the users who received the disclosure contract if the disclosure includes a Loan Estimate. For both Provider types (Encompass and Other), the Intent to Proceed contract includes the Intent to Proceed date, the name of the user who received the disclosure, and the method by which the user received the intent to proceed. This is captured on the disclosure tracking record associated with the Loan Estimate the borrower is accepting.
disclosureRecipients Arraydata": { "h-0": "ATTRIBUT	Information about the users who received the disclosure contract. The following applies to both Provider types (Encompass and Other): - This attribute provides the disclosed method, actual received date (at receipt), and tracking eConsent details (at send, if consent available, or at update if received after send) of each recipient. - The Disclosure Recipients themselves will be calculated by the API. Disclosure records cannot be split to deliver disclosures individually to recipients on the same application.
disclosedDailyInterest LockableDecimalFieldContract	Object containing information about the daily interest amount listed on the latest disclosure sent to the borrower.
disclosedApr LockableDecimalFieldContract	The calculated annual percentage rate for the loan that was last disclosed to the borrower. If the difference between the Disclosed APR and the Current APR is greater than .125 (above or below) for a Conventional loan or greater that .25 (above or below) for an ARM loan, an alert will notifying you that the new APR must be disclosed to the borrower.
disclosedFinanceCharge LockableDecimalFieldContract	Object containing information about the locked and disclosed Finance Charge.
loanProgram string	The Loan Program associated with the loan. This attribute is for RetrieveOnly.
loanAmount number	Amount of the loan. This attribute is for RetrieveOnly.
disclosureCreatedDate string	The date and time in UTC that the disclosure was created. DateTime: yyyy-MM-ddTHH:mm:ssZ RetrieveOnly.
applicationDate string	The date the loan application was received by the Loan Originator. The format is yyyy-MM-dd. RetrieveOnly.
propertyAddress AddressContract	Object containing information about the subject property. The subject property is the property for which the loan is being obtained. RetrieveOnly.
useForUcdExport boolean	Indicates whether the Closing Disclosure is selected as the disclosure to send for UCD (Uniform Closing Dataset) to Fannie Mae or Freddie Mac.
feeLevelDisclosuresIndicator boolean	Indicates whether fees must be redisclosed at the fee level (i.e., users must send revised disclosures when a fee is changed). RetrieveOnly.
changedCircumstanceIndicator boolean	Indicates whether there was a revision or change in circumstance.
changeInCircumstance string	Description of the change in circumstance.
changeInCircumstanceComments string	Comments for the change in circumstance.
loanEstimate LoanEstimateFieldsContract	Object containing information about the loan estimate.
closingDisclosure ClosingDisclosureFieldsContract	Object containing information about the closing disclosure.
tracking TrackingFieldsContract	Object containing details about the disclosure package types.
fulfillments Arraydata": { "h-0": "	For both Provider types (Encompass and Other), this provides details about the latest package that was printed and sent to the borrower(s) or non-borrowing owner(s) (if applicable). Details include the disclosed method, the user who ordered fulfillment, the date/time the fulfillment was processed, and recipient information.
linkedLogId string	This attribute is for RetrieveOnly.
feeChanges Arraydata": { "h-0": "ATTRIBUT	Details for each fee change. This attribute is for RetrieveOnly.
documents DisclosureTrackingDocumentsContract	Object containing details about the disclosure documents that were sent electronically to the borrower in an eDisclosure package. Response attribute only. Calculated based on the "contents" attribute in request.
snapshot inline_model_7	This attribute is for RetrieveOnly.
loanXml string	This attribute is for ServiceToServiceOnly.

Disclosed Date Field and Lockable Fields Contracts

The attributes listed in the table below make up the following object contracts:

DisclosedDateFieldContract
LockableUserRefFieldContract
LockableDecimalFieldContract
LockableStringFieldContract
LockableDateFieldContract
LockableBorrowerTypeFieldContract

ATTRIBUTE	DESCRIPTION
useUserValue boolean	Required. Indicates whether the field value is locked and will not automatically be recalculated by Encompass, even if related or dependent fields are changed. Corresponds to the Lock icon in Encompass. When useUserValue is “True”, the field is locked. If the field is locked, the user value will be used instead of the computed value.
userValue string	Manually entered value.
computedValue string	Automatically calculated value.
computedName string	Used in the LockableUserRefFieldContract only. The calculated name.

Intent to Proceed Contract Attributes

The following attributes make up the IntentToProceedContract object, which contains information related to the users who received the disclosure contract if the disclosure includes a Loan Estimate.

ATTRIBUTE	DESCRIPTION
intent boolean	Indicates that the disclosure includes a Loan Estimate.
date string	The Intent to Proceed date. The format is yyyy-MM-dd.
receivedBy LockableStringFieldContract	The name of the user who received the Loan Estimate disclosure.
receivedMethod string	The method by which the user received the intent to proceed. Possible values are: - ByMail - eDisclosure - Fax - InPerson - Other - Email - Phone - Signature - ClosingDocsOrder - eClose
receivedMethodOther string	Description of Other, if the receivedMethod is Other.
comments string	Additional comments.

Disclosure Recipient Contract

The following attributes make up the DisclosureRecipientContract object, which contains information related to the users who received the disclosure contract.

Where to find these field attributes in Encompass:

Some of these attributes can be found in Encompass on the Encompass Loan> Disclosure Tracking Tool> Disclosure Details > Details tab.

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the recipient.
recipientType string	Type of recipient. Possible values are: - Borrower - CoBorrower - NonBorrowingOwner - LoanAssociate - OtherThis attribute is for RetrieveOnly.
name string	Name of the recipient. This attribute is for CreateOnly.
email string	Email address of the recipient. This attribute is for CreateOnly.
disclosedMethod string	The method by which the borrower received the disclosure. Possible values are: - U.S. Mail - eDisclosure - Fax - In Person - Phone - Email - Signature - eClose (RetrieveOnly) - ClosingDocsOrder (RetrieveOnly) - eDisclosures (RetrieveOnly)
disclosedMethodDescription string	Description of Other, if the disclosedMethod is Other.
role DisclosureRecipientRoleReferenceContract	Object containing details about the disclosure recipient. This attribute is for CreateOnly.
presumedReceivedDate LockableDateFieldContract	Object containing information about the presumed date the borrower received the disclosure.
actualReceivedDate string	The actual date the borrower received the disclosure.. The format is yyyy-MM-dd.
borrowerType LockableBorrowerTypeFieldContract	Object containing information about the borrower type. Possible values include: - Individual - Co-signer - Title only - Non title spouse - Trustee - Title only trustee - Settlor trustee - Settlor - Title only settler trustee - Officer
tracking DisclosureRecipientTrackingContract	Object containing important dates such as when the borrower accepted consent, viewed messages, eSigned documents, etc. This attribute is for RetrieveOnly.

Address Contract Attributes

The following attributes make up the AddressContract object, which contains information about the subject property (the property for which the loan is being obtained).

ATTRIBUTE	DESCRIPTION
city string	The city in which the subject property is located.
state string	The state in which the subject property is located.
street1 string	The street address of the subject property.
street2 string	The street address of the subject property.
zip string	The zip code in which the subject property is located. The format is: Zip Code: #####-####

Loan Estimate Fields Contract

The following attributes make up the LoanEstimateFieldsContract object, which contains information that describes the purpose of a revised LE disclosure.

Some of these attributes can be found in Encompass on the Encompass Loan> Disclosure Tracking Tool> Disclosure Details > Reasons tab.

ATTRIBUTE	DESCRIPTION
isDisclosedByBroker boolean	Indicates whether the LE was disclosed by the broker.
isChangedCircumstanceSettlementCharges boolean	Indicates whether the change was due to Settlement Charges.
isChangedCircumstanceEligibility boolean	Indicates whether the change was due to Eligibility.
isRevisionsRequestedByConsumer boolean	Indicates whether the change was due to Revisions Requested By the Consumer.
isInterestRateDependentCharges boolean	Indicates whether the change was due to Interest Rate Dependent Charges.
isExpiration boolean	Indicates whether the change was due to Expiration.
isDelayedSettlementOnConstructionLoans boolean	Indicates whether the change was due to Delayed settlement on construction loans.
isOther boolean	Indicates whether the change was due to Other reasons.
otherDescription string	Description of Other reasons.
changesReceivedDate string	The date on which the changes were received. The format is yyyy-MM-dd.
revisedDueDate string	Date on which a revised Loan Estimate is due to be sent to the borrower. The Loan Estimate must be redisclosed to the borrower within 3 business days of the Changes Received Date. The format is yyyy-MM-dd. RetrieveOnly.

Closing Disclosure Fields Contract

The following attributes make up the ClosingDisclosureFieldsContract object, which contains information that describes the purpose of a revised closing disclosure.

Some of these attributes can be found in Encompass on the Encompass Loan> Disclosure Tracking Tool> Disclosure Details > Reasons tab.

ATTRIBUTE	DESCRIPTION
isChangeInAPR boolean	Indicates whether the change was due to Change in APR.
isChangeInLoanProduct boolean	Indicates whether the change was due to Change in Loan Product.
isPrepaymentPenaltyAdded boolean	Indicates whether the change was due to Prepayment Penalty Added.
isChangeInSettlementCharges boolean	Indicates whether the change was due to Settlement Charges.
is24HourAdvancePreview boolean	Indicates whether the change was due to 24-hour Advanced Preview.
isToleranceCure boolean	Indicates whether the change was due to Revisions Requested By the Customer.
isClericalErrorCorrection boolean	Indicates whether the change was due to Clerical Error Correction.
isChangedCircumstanceEligibility boolean	Indicates whether the change was due to Eligibility.
isInterestRateDependentCharges boolean	Indicates whether the change was due to Interest Rate Dependent Charges .
isRevisionsRequestedByConsumer boolean	Indicates whether the change was due to Revisions Requested By the Consumer.
isOther boolean	Indicates whether the change was due to Other reasons.
otherDescription string	Description of Other reasons.
changesReceivedDate string	The date on which the changes were received. The format is yyyy-MM-dd.
revisedDueDate string	Date on which a revised Closing Disclosure is due to be sent to the borrower. The format is yyyy-MM-dd. RetrieveOnly.

Tracking Fields Contract

The following attributes make up the TrackingFieldsContract object, which contains information that describes the purpose of a revised closing disclosure.

ATTRIBUTE	DESCRIPTION
disclosurePackageTypes Arraydata": {	Types of disclosure packages. Possible values are: - ApplicationPackage - ApprovalPackage - LockPackage - ThreeDayPackage Applicable to ServiceToServiceOnly and CreateOnly.
packageCreatedDate string	The date on which the package was created. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
packageId string	Applicable to ServiceToServiceOnly.
docPackageId string	Unique identifier of the package. Applicable to ServiceToServiceOnly and CreateOnly.

Disclosure Fee Change Contract

The following attributes make up the DisclosureFeeChangeContract object, which contains information that describes a fee change.

Some of these attributes can be found in Encompass on the Encompass Loan> Disclosure Tracking Tool> Disclosure Details > Reasons tab > Fee Changes table.

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the fee change.
fieldId string
feeDescription string	The fee description.
changedCircumstance string	A description of the changed circumstance.
comments string	Fee-level comments.
amount string	New fee amount.
reason string	Description of the change in circumstance.
changesReceivedDate string	Date of the changes in circumstance was received. The format is yyyy-MM-dd.

Disclosure Tracking Documents Contract

The following attributes make up the DisclosureTrackingDocumentsContract object.

ATTRIBUTE	DESCRIPTION
viewableFormsFile string	Applicable to ServiceToServiceOnly and CreateOnly.
forms Arraydata": { "h-0": "ATT	Applicable to CreateOnly.

Disclosure Recipient Role Reference Contract

The following attributes make up the DisclosureRecipientRoleReferenceContract object.

ATTRIBUTE	DESCRIPTION
entityId string	Required.
entityName string	RetrieveOnly.
entityType string	Required. Possible values are: - Borrower - NonBorrowingOwner - LoanAssociate - Other
entityUri string	RetrieveOnly. Not applicable at this time.
entityDescription string
legacyId string	This is the application ID of the borrower pair in case the loan was created using the V1 Loan API. RetrieveOnly.
application ApplicationReferenceContract	RetrieveOnly.

Disclosure Recipient Tracking Contract

The following attributes make up the DisclosureRecipientTrackingContract object.

ATTRIBUTE	DESCRIPTION
viewConsentDate string	The time and date that the borrower viewed the consent request. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
viewMessageDate string	The time and date that the borrower viewed the message. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
viewESignedDate string	The time and date that the borrower viewed the eSign request. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
viewWetSignedDate string	The time and date that the borrower viewed the wet sign request. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
acceptConsentDate string,	The time and date that the borrower accepted the consent request.
acceptConsentIP string	IP Address that the borrower was on while accepting eConsent. Applicable to ServiceToServiceOnly.
rejectConsentDate string	The time and date that the borrower rejected the consent request. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
rejectConsentIP string	IP Address that the borrower was on while rejecting eConsent. Applicable to ServiceToServiceOnly.
authenticatedDate string	Time and date that the co-borrower authenticated. The format is yyyy-MM-ddTHH:mm:ssZ Applicable to ServiceToServiceOnly.
authenticatedIP string	IP Address that the co-borrower was on while authenticating. Applicable to ServiceToServiceOnly.
eSignedDate string	The time and date that the borrower e-signed the eDisclosure package consent. Applicable to ServiceToServiceOnly.
eSignedIP string	IP Address that the borrower was on while eSigning. Applicable to ServiceToServiceOnly.
wetSignedDate string	The time and date that the borrower wet-signed the package The format is yyyy-MM-ddTHH:mm:ssZ
loanLevelConsent string	Borrower’s loan level consent: - Accepted - Rejected Applicable to ServiceToServiceOnly and CreateOnly.

Fulfillment Contract

The following attributes make up the FulfillmentContract object.

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the fulfullment
isManual boolean	Indicates whether the disclosure package was manually fulfilled. This is system-generated based on setting in Encompass Settings > Persona. If Automatic fulfillment is enabled, then isManual=false. RetrieveOnly.
disclosedMethod string	If manual fulfilled, the fulfillment method of the package. Possible values are: - ByMail - InPerson Required when adding manual fulfillment to an existing Disclosure Tracking log.
orderedBy string	User who ordered fulfillment. Required when adding manual fulfillment to an existing Disclosure Tracking log.
processedDate string	Date and Time that the fulfillment was processed on. The format is yyyy-MM-ddTHH:mm:ssZ. Required when adding manual fulfillment to an existing Disclosure Tracking log.
recipients Arraydata": { "h-0": "ATTRIBUTE	Information provided by the FulfillmentRecipientContract.

Fulfillment Recipient Contract

The following attributes make up the FulfillmentRecipientContract object.

ATTRIBUTE	DESCRIPTION
id string	Unique identifier of the recipient. Required when updating the Disclosure Tracking log. RetrieveOnly when adding a manual fulfillment to an existing Disclosure Tracking log.
presumedDate string	The presumed date the borrower will receive the package. The format is yyyy-MM-dd. RetrieveOnly
actualDate string	Actual date the borrower received the eDisclosure package. The format is yyyy-MM-dd.
comments string	Comment added at the time of manual fulfillment. CreateOnly

Disclosure Form Contract

The following attributes make up the DisclosureFormContract object, which contains information that describes the forms associated with the disclosure tracking record.

ATTRIBUTE	DESCRIPTION
formName string	Required. Name of the form.
formType string	Type of form. Possible values are: - eDisclosure - StandardForm - CustomForm - Needed - ClosingDocsOrder - eFolder - CoverSheet
signatureType string	Indicates whether a form is eSignable (can be signed electronically), Wet Sign Only (a paper copy must be signed and returned by mail or fax), or Informational (no signature required). Possible values are: - Informational - eSignature - WetSignature
viewableFormFile string	This attribute is applicable to eClose only. Applicable to ServiceToServiceOnly and CreateOnly.

Application Reference Contract

The following attributes make up the ApplicationReferenceContract object.

ATTRIBUTE	DESCRIPTION
entityId string	Required. The applicationId for the borrower pair for which the DT record is created.
entityName string	Not applicable at this time.
entityURI string	Not applicable at this time.
entityType string	Type of the entity - Application.
legacyId string	This is the application ID of the borrower pair in case the loan was created using the V1 Loan API. RetrieveOnly.