Lenders can now trigger service orders to partners using workflow rules. When these rules are triggered by a newly created task in Encompass, partners receive the newly created taskId in the webhook notification. The UPDATE_TASK result action can then be used to update or close the task.

Prerequisites

To use the transaction patch, the product must be entitled to the UPDATE_TASK action.
A product is entitled to the UPDATE_TASK action when it is added to the response.results array for the relevant request type under $.entitlements.data.transaction.

{
  "action": "UPDATE_TASK",
  "formats": [
    "application/vnd.task.update-1.0.0.json"
  ]
}

The fields included in 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": {
        "action": "UPDATE_TASK",
        "format": "application/vnd.task.update-1.0.0.json",
        "details": {
            ... // update task action details
        }
    },
    "partnerStatus": "partner status"
}

`format` and `action`

The Encompass Partner Connect (EPC) Platform uses $.result.format and $.result.action to determine how action details in the transaction PATCH payload are processed.
Ensure that the following values are specified:

{
  "format": "application/vnd.task.update-1.0.0.json",
  "action": "UPDATE_TASK"
}

List of fields in the `UPDATE_TASK` result action

Fields	Additional Information
`$.result.details.id`	The unique identifier for the task. Communicated in the transaction creation webhook.
`$.result.details.status`	The current status of the task. Allowed values: urn:ice:epc:partner:credit:report:version:V2.3.1.
`$.result.details.comment`	Optional comment.

The complete list of supported fields for the Update Credit Data action is defined in the JSON Schema object below. You can use online tools such as JSON Schema Validator to manually validate the contents of the result details object.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the task."
    },
    "status": {
      "type": "string",
      "enum": [
        "IN_PROGRESS",
        "COMPLETED"
      ],
      "description": "The current status of the task."
    },
    "comment": {
      "type": "string",
      "description": "An optional comment associated with the task."
    }
  },
  "required": [
    "id",
    "status"
  ],
  "additionalProperties": false
}

Sample update credit data request payload with most of the supported fields:

{
    "status": "processing",
    "loanFormat": "application/vnd.plm-2.0.0+json",
    "result": {
        "format": "application/vnd.task.update-1.0.0.json",
        "action": "UPDATE_TASK",
        "details": {
            "id": "cbb20fc3-ddd6-4d71-8776-599636194822",
            "status": "IN_PROGRESS",
            "comment": "Team still working on it"
        },
        "partnerStatus": "partner status"
    }
}

Prerequisites

format and action

List of fields in the UPDATE_TASK result action

`format` and `action`

List of fields in the `UPDATE_TASK` result action