Using Callbacks

Overview

Callbacks can be configured at an account level within Expere Document Services or at the time of the request.

To configure callbacks at an account level, users can work with their Professional Services representative to get this setup. At request time, the container for ‘callback’ still needs to be included, however, the subsequent information like URL and authentication information would not be required. For example:

"callback": {},
            "delivery": {
                "deliveryHold": false,
                "deliveryMode": "DirectToPaper",

When callback information is not configured at an account level, but a callback is still desired, the request would need to contain the applicable callback information:

• Callback container
• URL
• Authentication Type
• Username/Password
• OR
• Token

General Callback Information

Timed Intervals: callbacks occur every minute; this frequency is configured by Wolters Kluwer and occurs in both the Customer Test (CT) and Production (Prod) environments.

Push Events and Statuses: these messages vary depending on whether the delivery status is set to Electronic, Print, or Electronic with ESign. See the following for more information:

Callback Routes

There are three endpoints for the Callback URL, consisting of the following:

• https://<URL>/generate-callback - alerts users to successfully/unsuccessfully generated documents
• https://<URL>/delivery-callback - provides a list of WKES statuses
• https://<URL>/deliverysetup-callback - alerts users to the creation of delivery groups and provides delivery setup

The endpoints should be used to receive callbacks for the corresponding REST API methods

Sample Request

{
  "generate": {
    "request": {
      "documentFormat": "PDF",
      "documentsToGenerate": [
        {
          "documentID": "string",
          "format": "PDF",
          "ancillaryOutput": [
            {
              "outputType": "Barcode",
              "watermark": {
                "imageURL": "string",
                "text": "string",
                "rotate": true,
                "location": "Top"
              },
              "setEncryption": {
                "strength128Bits": true,
                "passwords": {
                  "user": "string",
                  "owner": "string"
                },
                "permissions": {
                  "allowPrinting": true,
                  "allowModifyContents": true,
                  "allowCopy": true,
                  "allowModifyAnnotations": true,
                  "allowScreenReaders": true,
                  "allowFillIn": true,
                  "allowAssembly": true,
                  "allowDegradedPrinting": true
                }
              },
              "barcode": {
                "type": "Barcode128",
                "pattern": "string",
                "useCoverPage": true,
                "firstPageOnly": true,
                "horizontalAlignment": "Left"
              },
              "eSignatureAndFieldSupport": {
                "eSignatureCoordinatesOnly": true,
                "eSignatureDateSupport": true,
                "eSignatureTooltip": "string",
                "eSignatureInitialsTooltip": "string",
                "nonSignatureFieldCoordinatesOnly": true,
                "eSignatureWKES": true
              },
              "logo": {
                "image": "string",
                "heightInInches": 0,
                "widthInInches": 0,
                "placement": "AllPages",
                "justification": "Left",
                "alternateText": "string"
              }
            }
          ]
        }
      ],
      "daysToExpire": 0,
      "transactionData": "string",
      "contentIdentifier": "string",
      "callback": {
        "authorization": {
          "authType": "HTTPBasic",
          "user": "string",
          "password": "string",
          "token": "string"
        },
        "url": "string"
      },
      "passthroughIdentifier": "string",
      "ancillaryOutput": [
        {
          "outputType": "Barcode",
          "watermark": {
            "imageURL": "string",
            "text": "string",
            "rotate": true,
            "location": "Top"
          },
          "setEncryption": {
            "strength128Bits": true,
            "passwords": {
              "user": "string",
              "owner": "string"
            },
            "permissions": {
              "allowPrinting": true,
              "allowModifyContents": true,
              "allowCopy": true,
              "allowModifyAnnotations": true,
              "allowScreenReaders": true,
              "allowFillIn": true,
              "allowAssembly": true,
              "allowDegradedPrinting": true
            }
          },
          "barcode": {
            "type": "Barcode128",
            "pattern": "string",
            "useCoverPage": true,
            "firstPageOnly": true,
            "horizontalAlignment": "Left"
          },
          "eSignatureAndFieldSupport": {
            "eSignatureCoordinatesOnly": true,
            "eSignatureDateSupport": true,
            "eSignatureTooltip": "string",
            "eSignatureInitialsTooltip": "string",
            "nonSignatureFieldCoordinatesOnly": true,
            "eSignatureWKES": true
          },
          "logo": {
            "image": "string",
            "heightInInches": 0,
            "widthInInches": 0,
            "placement": "AllPages",
            "justification": "Left",
            "alternateText": "string"
          }
        }
      ],
      "attachments": [
        {
          "attachmentDoc": "string",
          "displayName": "string",
          "instanceFileName": "string",
          "attachmentPosition": "Beginning",
          "passwords": {
            "user": "string",
            "owner": "string"
          }
        }
      ],
      "attachmentPosition": "Beginning",
      "oppsa": {
        "organizationName": "string",
        "productNames": [
          "string"
        ]
      },
      "mergeTRIDDocs": true,
      "ezConfig": {
        "orgId": "string",
        "orgName": "string",
        "orgAlias": "string",
        "orgLOB": "string"
      },
      "delivery": {
        "deliveryHold": true,
        "deliveryMode": "ImageOnly",
        "recipients": [
          {
            "name": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "city": "string",
            "state": "string",
            "zip": "string",
            "countryCode": "string",
            "mailingMethod": [
              "USPSFirstClass"
            ]
          }
        ],
        "returnAddress": {
          "name": "string",
          "businessName": "string",
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "countryCode": "string"
        },
        "fiPreConsent": true
      }
    }
  }
}

Callback message

The user will receive a callback message that could resemble the following:

{"deliveryResponse":{"transactionIdentifier":"459771","passthroughIdentifier":null,"groupId":"403eab3c-752f-4212-a901-2dca58ff7776",
"Package":{"PackageDetail":{"Id":"4543067","Status":"DirectToPaper","PushEvent":"CREATED","ReturnedReceivedMsgId":"","LoanNumber":"999888777","Comment":""},
"PackageAttachments":{"Attachments":{"Attachment":[{"Name":"HUD Approved Counseling Agencies-NV - Oscar James Obligor, Jr..pdf","Number":"0"},{"Name":"HUD Approved Counseling Agencies-NV - Betty Lou Smith.pdf","Number":"1"},
{"Name":"Notice of Intent to Foreclose-NV - Oscar James Obligor, Jr..pdf","Number":"2"},{"Name":"Notice of Intent to Foreclose-NV - Betty Lou Smith.pdf","Number":"3"}]},"PackageStatuses":{"PackageStatus":{"Action":"REVIEW","Recipient":"paperout@wolterskluwer.com","Received":"Thu, Feb 04, 2021 14:54:55","Viewed":"","Purged":"","Recalled":"","Signed":"","Rejected":"","PaperRequested":"","DirectToPaper":"Thu, Feb 04, 2021 14:54:55","PaperCompleted":"","PaperNote":"","Label":"","PackageError":"","Consented":"","PushedToVault":"","PushedToVaultNote":"","AdditionalData":"","UserTag":"","TRIDUndeliverable":"","ReceivedMsgId":"4542447"}}}
2021-02-04 14:57:37.203 -06:00 [INF] Executing HttpStatusCodeResult, setting HTTP status code 200

Sample callbacks

See Sample Callbacks for more information.