Update disclosure tracking log v2
A documents integration can update a disclosure tracking log by patching a transaction and returning the required field values along with a response result object that specifies the action UPDATE_DISCLOSURE. You can support both v1 and v2 within the same product.
Prerequisite
Product must be entitled to the
UPDATE_DISCLOSUREaction to use it during transaction patch.A product can be entitled to the
UPDATE_DISCLOSUREaction by adding it in theresponse.resultsarray of the specific request type within$.entitlements.data.transaction.{ "action": "UPDATE_DISCLOSURE", "formats": [ "application/vnd.disclosure-update-1.0.0.json", "application/vnd.disclosure-update-2.0.0.json" ] }
The fields included in the response loan data follow the standard data entitlement model and processing.
{
"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-2.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 properly handle the action details sent in the transaction PATCH payload. Make sure you use:"format": "application/vnd.disclosure-update-2.0.0.json"
"action": "UPDATE_DISCLOSURE"
The complete list of supported fields in the create disclosure tracking log action details is defined in the JSON-schema below. You can use online tools, such as https://www.jsonschemavalidator.net/, to manually validate the contents of a details object.
The v2 schema builds on the v1 schema by adding the fulfillments section.
{
"$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,
"maxItems": 1,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"recipients": {
"type": "array",
"minItems": 1,
"maxItems": 1,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actualDate": {
"type": "string"
}
},
"required": [
"id",
"actualDate"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"recipients"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
Below is a sample request payload for updating a disclosure tracking log, showcasing most of the fields supported by the operation. Note the addition of the fulfillments section:
{
"status": "Completed",
"loanFormat": "application/vnd.plm-2.0.0+json",
"result": {
"format": "application/vnd.disclosure-update-2.0.0.json",
"action": "UPDATE_DISCLOSURE",
"details": {
"id": "75297ce5-de61-426f-84b4-2e5127ea800a",
"includedInTimeline": true,
"status": "Active",
"disclosureRecipients": [
{
"id": "0750c04f-c90d-4a26-8411-8dc4cbad5794",
"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": {
"authenticatedDate": "2024-10-16T20:13:45.485Z",
"authenticatedIP": "string",
"viewConsentDate": "2024-10-16T20:13:45.485Z",
"acceptConsentDate": "2024-10-16T20:13:45.485Z",
"acceptConsentIP": "string",
"rejectConsentDate": "2024-10-16T20:13:45.485Z",
"rejectConsentIP": "string",
"viewMessageDate": "2024-10-16T20:13:45.485Z",
"informationalViewedDate": "2024-10-16T20:13:45.485Z",
"informationalViewedIP": "string",
"informationalCompletedDate": "2024-10-16T20:13:45.485Z",
"informationalCompletedIP": "string",
"viewESignedDate": "2024-10-16T20:13:45.485Z",
"eSignedDate": "2024-10-16T20:13:45.485Z",
"eSignedIP": "string",
"viewWetSignedDate": "2024-10-16T20:13:45.485Z",
"wetSignedDate": "2024-10-16T20:13:45.485Z"
}
}
],
"disclosedDailyInterest": {
"useUserValue": true,
"userValue": 0
},
"disclosedApr": {
"useUserValue": true,
"userValue": 0
},
"disclosedFinanceCharge": {
"useUserValue": true,
"userValue": 0
},
"changedCircumstanceIndicator": true,
"changeInCircumstance": "string",
"changeInCircumstanceComments": "string",
"fulfillments": [
{
"id": "<fulfillment.id>",
"recipients": [
{
"id": "<recipient.id>",
"actualDate": "2023-03-29"
}
]
}
]
}
}
}