V3 Add a Disclosure Tracking Log

Creates and adds a Disclosure Tracking 2015 log to the specified loan.

Path Params
string
required

The unique identifier assigned to the loan.

Query Params
boolean

Indicates whether to add a snapshot of the Disclosure Tracking log.

string

The unique identifier assigned to the application for which to add the disclosure tracking log.

Body Params
string

Unique identifier of the Disclosure Tracking 2015 log.

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. Valid values:

  • 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.
string

Name of the service provider responsible for creating and
maintaining the record.

contents
array

List of key documents associated with the record. Note: The document values must be unique. This attribute is for CreateOnly. Valid values:

  • LE
  • CD
  • ServiceProviderList
  • ServiceProviderListNoFee
  • SafeHarbor

The 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.
contents
boolean
Defaults to true

Indicates whether to include the Closing Disclosure in the Disclosure Tracking timeline. The default is true.
This attribute is for Create and Update.

string

Status of DT Log record. Valid values:

  • Active
  • PendingApplicable to ServiceToServiceOnly
string

Type of Disclosure. Valid values:

  • Initial
  • Revised
  • Final
  • PostConsummation
disclosedDate
object

Object containing user and computed disclosed date values.

disclosedBy
object

Object containing information about who created the disclosure record (who locked and sent the disclosure to the borrower).

string

The method by which the recipient(s) received the disclosure. Valid values:

  • ByMail
  • Fax
  • InPerson
  • Email
  • Phone
  • Signature
  • Other
string

Description of Other, if the disclosedMethod is Other.

intentToProceed
object

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
array of objects

Information about the users who received the disclosure.
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.

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

disclosureRecipients
disclosedDailyInterest
object

Object containing information about the daily interest amount listed on the latest disclosure sent to the borrower.

disclosedApr
object

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
object

Object containing information about the locked and disclosed Finance Charge.

string

RetrieveOnly. The Loan Program associated with the loan.

number

RetrieveOnly. Amount of the loan.

string

RetrieveOnly. The date and time in UTC that the disclosure was created. DateTime: yyyy-MM-ddTHH:mm:ssZ

string

RetrieveOnly. The date the loan application was received by the Loan Originator. The format is yyyy-MM-dd.

propertyAddress
object

RetrieveOnly. Object containing information about the subject property. The subject property is the property for which the loan is being obtained.

boolean

Indicates whether the Closing Disclosure is selected as the disclosure to send for UCD (Uniform Closing Dataset) to Fannie Mae or Freddie Mac.

boolean

RetrieveOnly. Indicates whether fees must be redisclosed at the fee level (i.e., users must send revised disclosures when a fee is changed).

boolean

Indicates whether there was a revision or change in circumstance.

string

Description of the change in circumstance.

string

Comments for the change in circumstance.

loanEstimate
object

Object containing information about the loan estimate.

closingDisclosure
object

Object containing information about the closing disclosure.

tracking
object

Object containing details about the disclosure package types.

fulfillments
array

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.

fulfillments
string

RetrieveOnly. The linked log ID.

feeChanges
array

RetrieveOnly. Details for each fee change.

feeChanges
documents
object

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
array of objects

RetrieveOnly. A read-only view of the disclosure information (e.g., Loan Estimate (LE) or Closing Disclosure (CD) data) as it appeared at that specific moment.

snapshot
string

This attribute is for ServiceToServiceOnly.

Headers
string
required

Bearer token

Responses

400

Bad Request

Language
URL
Response
Choose an example:
application/json