Generate method

Overview

This method can be used to request document generation similar to our existing Generate or SelectAndGenerate APIs within our SOAP method. This method is unique from the SOAP method, as it can also be used to create Delivery Group(s) and/or submit the request for Delivery through Wolters Kluwer ESign.

For a simple document generation request where delivery groups or package delivery through WKES is not desired the ‘delivery’ section of the request should not be included.

Requests where document generation, and delivery groups or package delivery through WKES is desired the ‘delivery’ section of the request should be included and completed based on the desired result.

The delivery section of the request provides the following options:

  • deliveryHold
    • This has a true/false value
    • When set to ‘true’ the documents for the request will be generated but will not be delivered.
    • When set to ‘false’ the documents for the request will be generated and attempt delivery in the manner provided in the request (see deliveryMode).
  • deliveryMode
    • This is an enumerated value with the following four options. This value should be set based on delivery needs.
      • ImageOnly
        • This delivery mode is used when only document generation is desired, and delivery groups and package delivery is not needed.
      • DirectToPaper
        • This delivery mode is used when document generation and delivery groups are to be created for Print Fulfillment delivery.
      • ElectronicWithESign
        • This delivery mode is used when document generation and delivery groups are to be created and delivered through WKES where package recipients can view and e-sign the package of documents.
      • ElectronicOnly
        • This delivery mode is used when document generation and delivery groups are to be created and delivered through WKES where package recipients can simply view the package of documents electronically, but eSigning is not required/supported.
  • Recipients
    • This should only be included if the Wolters Kluwer Delivery Grouping logic should not be used.
    • By including this in the request, the package of documents will be generated and the full package of documents will be delivered via the Paper method to each recipient provided in the request.
    • To use Wolters Kluwer Delivery Grouping Logic, this should NOT be included in the request, and a deliveryMode of ElectronicOnly, ElectronicWithESign, or DirectToPaper would need to be set.
  • returnAddress
    • This is the return address to included on the document package for DirectToPaper delivery. If the package cannot be delivered to the recipients mailing address, this is the address the package would be returned to.
    • This should be included for all requests where deliveryMode is set to DirectToPaper.
  • fiPreConsent
    • FI Pre-Consent is intended for those customers who have implemented a system/process with WKES to track and maintain the user consent, in alignment with ESIGN and UETA requirements.
    • This is not used or functional at this time. This will be used in a future enhancement where customers have a system in place outlined above.

Special Considerations

  • Delivery Groups
    • Delivery groups are unique groups of the documents generated in a package/request. Documents generated from the request are grouped/packaged based on unique recipient(s) of the documents.
    • Delivery groups are created differently based on the deliveryMode set in the request.
    • When creating delivery groups for ElectronicOnly or ElectronicWithESign, all parties must have an email address, in a ‘consent’ status within WKES. If an email address is not provided for all parties, or any email addresses are not set to ‘consent’ in WKES, the packages will be sent via DirectToPaper (assuming all paper delivery information is provided).
Note: For either electronic delivery method (ElectronicOnly or ElectronicWithEsign,) all package recipients (parties on the transaction) must contain a unique email address.

Related topics