Update disclosure tracking status

Suggest Edits

A documents delivery integration can update a disclosure tracking log entry status 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.

📘

Pre-requisite

Product have to be entitled to UPDATE_DISCLOSURE_STATUS action in order to use it dusing transaction patch.

A product can be entitled to UPDATE_DISCLOSURE_STATUS action by adding it in the response.results array of the specific 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",
        "respondingParty": {
            "name": "Doc delivery partner",
            "address": "P.O. BOX 509124, SUITE 300",
            "city": "SAN DIEGO",
            "state": "CA",
            "postalCode": " 92150",
            "pointOfContact": {
                "fax": "8002376526",
                "phone": "8009864343",
                "email": "[email protected]"
            }
        },
        "referenceNumber": "000901"
    }
}

📘

format and action

The Encompass Partner Connect Platform (EPC) 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-status-1.0.0.json"
"action": "UPDATE_DISCLOSURE_STATUS"

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

Below is a sample update disclosure tracking log request payload with most of the fields supported in the update disclosure tracking log operation:

{
    "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"
        },
        "partnerStatus": "partner status",
        "respondingParty": {
            "name": "PPE partner",
            "address": "P.O. BOX 509124, SUITE 300",
            "city": "SAN DIEGO",
            "state": "CA",
            "postalCode": " 92150",
            "pointOfContact": {
                "fax": "8002376526",
                "phone": "8009864343",
                "email": "[email protected]"
            }
        },
        "referenceNumber": "000901"
    }
}

Updated 18 days ago