Update disclosure tracking log
A documents integration can update a disclosure tracking log by patching a transaction with a response that returns the required field values, and with a response result object with the action UPDATE_DISCLOSURE. Use $.result.details.id to identify the disclosure tracking log to update.
Schema versions
This page documents
application/vnd.disclosure-update-1.0.0.json. Version 2.0.0 restricts fulfillment updates to a single fulfillment and recipient. See Update disclosure tracking log v2.
Prerequisite
The product must be entitled to the
UPDATE_DISCLOSUREaction to use it in a transaction PATCH.To entitle a product, add the action to the
response.resultsarray of the relevant request type within$.entitlements.data.transaction:{ "action": "UPDATE_DISCLOSURE", "formats": [ "application/vnd.disclosure-update-1.0.0.json" ] }
The specific fields that are sent as part of the response loan data follow the standard data entitlement model and process.
{
"status": "processing",
"loanFormat": "application/vnd.plm-2.0.0+json",
"loan": {
... // Additional loan data, sent as part of standard transaction loan update
},
"result": {
"format": "application/vnd.disclosure-update-1.0.0.json",
"action": "UPDATE_DISCLOSURE",
"details": {
... // Update disclosure action details
}
},
"partnerStatus": "partner status"
}
format and action
The Encompass Partner Connect (EPC) Platform uses
$.result.formatand$.result.actionto determine how to process the action details sent in the transaction PATCH payload. Make sure you use:
"format": "application/vnd.disclosure-update-1.0.0.json"
"action": "UPDATE_DISCLOSURE"
The complete list of supported fields in the update disclosure tracking log action details object is defined in the JSON schema below. You can use online tools such as JSON Schema Validator to manually validate the contents of a details object.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"includedInTimeline": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"Active"
]
},
"disclosureType": {
"type": "string",
"enum": [
"Initial",
"Revised",
"Final",
"PostConsummation"
]
},
"disclosedDate": {
"type": "object",
"properties": {
"userValue": {
"type": "string"
},
"useUserValue": {
"type": "boolean"
}
},
"additionalProperties": false
},
"disclosedBy": {
"type": "object",
"properties": {
"useUserValue": {
"type": "boolean"
},
"userValue": {
"type": "string"
}
},
"additionalProperties": false
},
"disclosedMethod": {
"type": "string",
"enum": [
"ByMail",
"Fax",
"InPerson",
"Email",
"Phone",
"Signature",
"Other"
]
},
"disclosedMethodDescription": {
"type": "string"
},
"intentToProceed": {
"type": "object",
"properties": {
"intent": {
"type": "boolean"
},
"date": {
"type": "string"
},
"receivedBy": {
"type": "object",
"properties": {
"useUserValue": {
"type": "boolean"
},
"userValue": {
"type": "string"
}
},
"additionalProperties": false
},
"receivedMethod": {
"type": "string",
"enum": [
"ByMail",
"eDisclosure",
"Fax",
"InPerson",
"Other",
"Email",
"Phone",
"Signature",
"ClosingDocsOrder",
"eClose"
]
},
"receivedMethodOther": {
"type": "string"
},
"comments": {
"type": "string"
}
},
"additionalProperties": false
},
"disclosureRecipients": {
"type": "array",
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"disclosedMethod": {
"type": "string",
"enum": [
"ByMail",
"Fax",
"InPerson",
"Email",
"Phone",
"Signature",
"Other"
]
},
"disclosedMethodDescription": {
"type": "string"
},
"presumedReceivedDate": {
"type": "object",
"properties": {
"userValue": {
"type": "string"
},
"useUserValue": {
"type": "boolean"
}
},
"additionalProperties": false
},
"actualReceivedDate": {
"type": "string"
},
"borrowerType": {
"type": "object",
"properties": {
"useUserValue": {
"type": "boolean"
},
"userValue": {
"type": "string"
}
},
"additionalProperties": false
},
"tracking": {
"type": "object",
"properties": {
"viewConsentDate": {
"type": "string"
},
"viewMessageDate": {
"type": "string"
},
"viewESignedDate": {
"type": "string"
},
"viewWetSignedDate": {
"type": "string"
},
"acceptConsentDate": {
"type": "string"
},
"acceptConsentIP": {
"type": "string"
},
"rejectConsentDate": {
"type": "string"
},
"rejectConsentIP": {
"type": "string"
},
"authenticatedDate": {
"type": "string"
},
"authenticatedIP": {
"type": "string"
},
"eSignedDate": {
"type": "string"
},
"eSignedIP": {
"type": "string"
},
"wetSignedDate": {
"type": "string"
},
"informationalViewedDate": {
"type": "string"
},
"informationalCompletedDate": {
"type": "string"
},
"informationalViewedIP": {
"type": "string"
},
"informationalCompletedIP": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"disclosedDailyInterest": {
"type": "object",
"properties": {
"useUserValue": {
"type": "boolean"
},
"userValue": {
"type": "integer"
}
},
"additionalProperties": false
},
"disclosedApr": {
"type": "object",
"properties": {
"useUserValue": {
"type": "boolean"
},
"userValue": {
"type": "integer"
}
},
"additionalProperties": false
},
"disclosedFinanceCharge": {
"type": "object",
"properties": {
"useUserValue": {
"type": "boolean"
},
"userValue": {
"type": "integer"
}
},
"additionalProperties": false
},
"useForUcdExport": {
"type": "boolean"
},
"changedCircumstanceIndicator": {
"type": "boolean"
},
"changeInCircumstance": {
"type": "string"
},
"changeInCircumstanceComments": {
"type": "string"
},
"loanEstimate": {
"type": "object",
"properties": {
"isDisclosedByBroker": {
"type": "boolean"
},
"isChangedCircumstanceSettlementCharges": {
"type": "boolean"
},
"isChangedCircumstanceEligibility": {
"type": "boolean"
},
"isRevisionsRequestedByConsumer": {
"type": "boolean"
},
"isInterestRateDependentCharges": {
"type": "boolean"
},
"isExpiration": {
"type": "boolean"
},
"isDelayedSettlementOnConstructionLoans": {
"type": "boolean"
},
"isOther": {
"type": "boolean"
},
"otherDescription": {
"type": "string"
},
"changesReceivedDate": {
"type": "string"
}
},
"additionalProperties": false
},
"closingDisclosure": {
"type": "object",
"properties": {
"isChangeInAPR": {
"type": "boolean"
},
"isChangeInLoanProduct": {
"type": "boolean"
},
"isPrepaymentPenaltyAdded": {
"type": "boolean"
},
"isChangeInSettlementCharges": {
"type": "boolean"
},
"is24HourAdvancePreview": {
"type": "boolean"
},
"isToleranceCure": {
"type": "boolean"
},
"isClericalErrorCorrection": {
"type": "boolean"
},
"isChangedCircumstanceEligibility": {
"type": "boolean"
},
"isInterestRateDependentCharges": {
"type": "boolean"
},
"isRevisionsRequestedByConsumer": {
"type": "boolean"
},
"isOther": {
"type": "boolean"
},
"otherDescription": {
"type": "string"
},
"changesReceivedDate": {
"type": "string"
}
},
"additionalProperties": false
},
"fulfillments": {
"type": "array",
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"orderedBy": {
"type": "string"
},
"processedDate": {
"type": "string"
},
"recipients": {
"type": "array",
"minItems": 1,
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actualDate": {
"type": "string"
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
Below is a sample update disclosure tracking log request payload with most of the fields supported by the operation:
{
"status": "completed",
"loanFormat": "application/vnd.plm-2.0.0+json",
"result": {
"format": "application/vnd.disclosure-update-1.0.0.json",
"action": "UPDATE_DISCLOSURE",
"details": {
"id": "75297ce5-de61-426f-84b4-2e5127ea800a",
"includedInTimeline": true,
"status": "Active",
"disclosedDate": {
"userValue": "2024-10-16T20:13:45.485Z",
"useUserValue": true
},
"disclosedBy": {
"useUserValue": true,
"userValue": "Jane Doe"
},
"disclosedMethod": "ByMail",
"disclosedDailyInterest": {
"useUserValue": true,
"userValue": 0
},
"disclosedApr": {
"useUserValue": true,
"userValue": 0
},
"disclosedFinanceCharge": {
"useUserValue": true,
"userValue": 0
},
"changedCircumstanceIndicator": true,
"changeInCircumstance": "Changed circumstance affecting settlement charges",
"changeInCircumstanceComments": "Appraised value came in lower than estimated",
"disclosureRecipients": [
{
"id": "id123",
"disclosedMethod": "ByMail",
"presumedReceivedDate": {
"userValue": "2024-10-16T20:13:45.485Z",
"useUserValue": true
},
"actualReceivedDate": "2024-10-16T20:13:45.485Z",
"borrowerType": {
"useUserValue": true,
"userValue": "Individual"
},
"tracking": {
"viewConsentDate": "2024-10-16T20:13:45.485Z",
"viewMessageDate": "2024-10-16T20:13:45.485Z",
"viewESignedDate": "2024-10-16T20:13:45.485Z",
"viewWetSignedDate": "2024-10-16T20:13:45.485Z",
"acceptConsentDate": "2024-10-16T20:13:45.485Z",
"acceptConsentIP": "203.0.113.10",
"rejectConsentDate": "2024-10-16T20:13:45.485Z",
"rejectConsentIP": "203.0.113.10",
"authenticatedDate": "2024-10-16T20:13:45.485Z",
"authenticatedIP": "203.0.113.10",
"eSignedDate": "2024-10-16T20:13:45.485Z",
"eSignedIP": "203.0.113.10",
"wetSignedDate": "2024-10-16T20:13:45.485Z",
"informationalViewedDate": "2024-10-16T20:13:45.485Z",
"informationalCompletedDate": "2024-10-16T20:13:45.485Z",
"informationalViewedIP": "203.0.113.10",
"informationalCompletedIP": "203.0.113.10"
}
}
]
}
}
}
Updated 6 months ago