Sample Callbacks

Overview

The following samples were extracted from a Generate, Delivery, and Delivery Setup REST API method; the logic of which should assist you in your implementation.

Generate

{
   "TransactionIdentifier":459667,
   "PassthroughIdentifier":null,
   "UpdateType":"GenerateUpdate",
   "Description":null,
   "TimeStamp":"2021-02-04T08:40:36.2048322-06:00"
}

Delivery

{
   "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"
               }
            }
         }
      }
   }

Delivery Setup

{
   "DeliverySetupSuccess":"Successful",
   "PassthroughIdentifier":null,
   "TransactionIdentifier":459667,
   "DeliveryMode":"DirectToPaper",
   "DeliveryGroup":[
      {
         "Name":"borrower one",
         "AddressLine1":"123 main street",
         "AddressLine2":"apt 4",
         "City":"Fargo",
         "State":"ND",
         "ZIP":"58102",
         "CountryCode":"USA",
         "MailingMethod":"USPSFirstClass",
         "DiscretePartyId":null,
         "GroupId":"8a36480f-5ec0-4b3a-813d-2f1c08efb07a",
         "Documents":[
            {
               "DocID":"PKGD.HUDApprovedCounselingAgencies-NV-DEF",
               "InstanceDisplayName":"HUD Approved Counseling Agencies-NV - Oscar James Obligor, Jr."
            },
            {
               "DocID":"PKGD.HUDApprovedCounselingAgencies-NV-DEF",
               "InstanceDisplayName":"HUD Approved Counseling Agencies-NV - Betty Lou Smith"
            },
            {
               "DocID":"PKGD.NoticeOfIntentToForeclose-NV-DEF",
               "InstanceDisplayName":"Notice of Intent to Foreclose-NV - Oscar James Obligor, Jr."
            },
            {
               "DocID":"PKGD.NoticeOfIntentToForeclose-NV-DEF",
               "InstanceDisplayName":"Notice of Intent to Foreclose-NV - Betty Lou Smith"
            }
         ],
         "EmailAddress":null
      },
      {
         "Name":"borrower one",
         "AddressLine1":"123 main street",
         "AddressLine2":"apt 4",
         "City":"Fargo",
         "State":"ND",
         "ZIP":"58102",
         "CountryCode":"USA",
         "MailingMethod":"FedExStandardOvernight",
         "DiscretePartyId":null,
         "GroupId":"e2c48299-ff5e-48ba-bfe9-2a24d4d88271",
         "Documents":[
            {
               "DocID":"PKGD.HUDApprovedCounselingAgencies-NV-DEF",
               "InstanceDisplayName":"HUD Approved Counseling Agencies-NV - Oscar James Obligor, Jr."
            },
            {
               "DocID":"PKGD.HUDApprovedCounselingAgencies-NV-DEF",
               "InstanceDisplayName":"HUD Approved Counseling Agencies-NV - Betty Lou Smith"
            },
            {
               "DocID":"PKGD.NoticeOfIntentToForeclose-NV-DEF",
               "InstanceDisplayName":"Notice of Intent to Foreclose-NV - Oscar James Obligor, Jr."
            },
            {
               "DocID":"PKGD.NoticeOfIntentToForeclose-NV-DEF",
               "InstanceDisplayName":"Notice of Intent to Foreclose-NV - Betty Lou Smith"
            }
         ],
         "EmailAddress":null
      }
   ]
}