Developer Guides

Update disclosure tracking status

Suggest Edits

A documents delivery integration can update the status of a disclosure tracking log entry by patching a transaction with a response that returns the required field values, and with a response result object with the action UPDATE_DISCLOSURE_STATUS.

📘

Prerequisite

The product must be entitled to the UPDATE_DISCLOSURE_STATUS action to use it in a transaction PATCH.

To entitle a product, add the action to the response.results array of the relevant request type within $.entitlements.data.transaction:

  {
    "action": "UPDATE_DISCLOSURE_STATUS",
    "formats": [
      "application/vnd.disclosure.update-status-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-status-1.0.0.json",
      "action": "UPDATE_DISCLOSURE_STATUS",
      "details": {
         ... // Update disclosure status action details
      }
   },
   "partnerStatus": "partner status"
}

📘

format and action

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

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

FieldAdditional Information
$.result.details.statusRequired. The status to set on the disclosure tracking log entry. Allowed value: active.
$.result.details.commentsOptional. Free-form comments.
$.result.details.disclosedDateOptional. Disclosed date in YYYY-MM-DD format.

The complete list of supported fields in the update disclosure tracking status 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",
  "validationMessage": {
    "date-pattern": "Date should be in the format YYYY-MM-DD."
  },
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "active"
      ]
    },
    "comments": {
      "type": "string"
    },
    "disclosedDate": {
      "type": "string",
      "format": "date",
      "validationMessage": {
        "$ref": "#/validationMessage/date-pattern"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "status"
  ]
}

Below is a sample update disclosure tracking status request payload with all of the supported fields:

{
    "status": "processing",
    "loanFormat": "application/vnd.plm-2.0.0+json",
    "result": {
        "format": "application/vnd.disclosure.update-status-1.0.0.json",
        "action": "UPDATE_DISCLOSURE_STATUS",
        "details": {
            "status": "active",
            "comments": "Disclosure package reactivated",
            "disclosedDate": "2023-03-10"
        }
    },
    "partnerStatus": "partner status"
}

Updated about 24 hours ago