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.

📘

Pre-requisite

Product has to be entitled to UPDATE_DISCLOSURE action in order to use it during transaction patch.

A product can be entitled to UPDATE_DISCLOSURE action by adding it in the response.results array of the specific 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": {
            ... //Create disclosure action details
              }
        },
        "partnerStatus": "partner status"
}

📘

format and action

The Encompass Partner Connect (EPC) Platform uses $.result.format and $.result.action to properly handle the action details sent in the transaction PATCH payload. Make sure you use:

"format": "application/vnd.disclosure-update-1.0.0.json"
"action": "CREATE_DISCLOSURE_TRACKING_LOG"

The full list of supported fields in the create disclosure tracking log action details are captured in the JSON-schema object definition below. There are several resources available online, such as https://www.jsonschemavalidator.net/, where a result details objects content can be manually validated.

{
    "$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
                        }
                    },
                    "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 in the update disclosure tracking log 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": {
            "includedInTimeline": true,
            "status": "Active",
            "disclosedDate": {
                "userValue": "2024-10-16T20:13:45.485Z",
                "useUserValue": true
            },
            "disclosedBy": {
                "useUserValue": true,
                "userValue": "string"
            },
            "disclosedMethod": "ByMail",
            "disclosedDailyInterest": {
                "useUserValue": true,
                "userValue": 0
            },
            "disclosedApr": {
                "useUserValue": true,
                "userValue": 0
            },
            "disclosedFinanceCharge": {
                "useUserValue": true,
                "userValue": 0
            },
            "changedCircumstanceIndicator": true,
            "changeInCircumstance": "string",
            "changeInCircumstanceComments": "string",
            "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"
                    }
                }
            ]
        }
    }
}