GetDeliveredImages method

The GetDeliveredImages operation retrieves the delivered PDF documents from a previously executed Deliver action (Generate with DeliveryHold = False, or a separate Delivery request) using a particular Transaction ID. When requesting GetDeliveredImages, the WKES Tracking ID is required.

ImageType parameter

Note: Users can reference the REST API documentation for more information on using the ImageTypeEnum.

Users can set the optional ImageType parameter to either Sent or Final:

  • When set to Sent, the images are returned based on the following method:
    • ElectronicWithEsign: The unsigned image which was sent to the recipients of the package will be returned.
    • ElectronicOnly: The sent image will be returned.
    • DirectToPaper: The mailed image which includes the mailing coversheet will be returned.
  • When set to Final, the images are returned based on the following method:
    • ElectronicWithEsign: The signed image will be returned.
    • ElectronicOnly: The sent image will be returned.
    • DirectToPaper: The mailed image which includes the mailing coversheet will be returned.

When the ImageType parameter is not set, the images are returned on the following method:

  • ElectronicWithEsign: The signed image will be returned.
  • ElectronicOnly: The sent image will be returned.
  • DirectToPaper: The mailed image which includes the mailing coversheet will be returned.

Special Considerations

When requesting Delivered Images for an ElectronicWithESign package, users will need to monitor the WKES package status updates and wait for a Package Status callback where the ‘Status’ = Signed, and the ‘PushEvent’ = Signed. This indicates all parties have signed the document package and the signed package can be requested.

Related Topics