Developer Guides

Create disclosure tracking log fulfillment

Suggest Edits

A documents integration can create a disclosure tracking log fulfillment by patching a transaction with a response that returns the required field values, and with a response result object with the action CREATE_FULFILLMENT_DISCLOSURE.

📘

Pre-requisite

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

A product can be entitled to CREATE_FULFILLMENT_DISCLOSURE action by adding it in the response.results array of the specific request type within $.entitlements.data.transaction.

          {
            "action": "CREATE_FULFILLMENT_DISCLOSURE",
            "formats": [
              "application/vnd.disclosure-fulfillment-create-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-fulfillment-create-1.0.0.json",
        "action": "CREATE_FULFILLMENT_DISCLOSURE",
        "details": {
            ... //Create disclosure fulfillment 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-create-1.0.0.json"
"action": "CREATE_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.. 

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "disclosureTrackingLogId": {
      "type": "string"
    },
    "disclosedMethod": {
      "type": "string",
      "enum": [
        "ByMail",
        "InPerson"
      ]
    },
    "orderedBy": {
      "type": "string"
    },
    "processedDate": {
      "type": "string"
    },
    "recipients": {
      "type": "array",
      "minItems": 1,
      "maxItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "actualDate": {
            "type": "string"
          },
          "comments": {
            "type": "string"
          }
        },
        "minProperties": 1,
        "additionalProperties": false
      }
    }
  },
  "required": [
    "disclosureTrackingLogId",
    "orderedBy",
    "processedDate",
    "disclosedMethod"
  ],
  "additionalProperties": false
}

Below is a sample request payload for creating a disclosure tracking log, showcasing most of the fields supported by the operation:

{
    "status": "Completed",
    "loanFormat": "application/vnd.plm-2.0.0+json",
    "result": {
        "format": "application/vnd.disclosure-fulfillment-create-1.0.0.json",
        "action": "CREATE_FULFILLMENT_DISCLOSURE",
        "details": {
            "disclosureTrackingLogId": "b22e6897-7435-465d-ad0c-da4b8d0b6ba7",
            "disclosedMethod": "ByMail",
            "orderedBy": "Test",
            "processedDate": "2023-03-24T11:11:11Z",
            "recipients": [
                {
                    "actualDate": "2023-03-29",
                    "comments": "Test Comments"
                }
            ]
        }
    }
}