Deliver method

Overview

This method can be used to Deliver document packages to delivery group(s) originally created through the Generate request, or to send the Generated document package to specified recipients in the Deliver request.

Delivery Modes

Listed below are the available delivery modes:

  • DirectToPaper
  • ElectronicOnly
  • ElectronicWithEsign

Delivery Groupings

Delivery Groups are a way to identify unique groupings of documents to be delivered for a recipient or group of recipients. One Generate request can result in one to many delivery groups.

Upon submitting a Generate Request with DeliveryMode = either ElectronicOnly, ElectronicWithESign, or DirectToPaper, a Delivery Group or Delivery Groups are created based on the DeliveryMode set. The Delivery Group will consist of a Group ID, the recipient information (for DirectToPaper delivery), or email address (for Electronic delivery), and Document ID's.

Special Considerations

  • When creating delivery groups for ElectronicOnly or ElectronicWithESign, all parties must have an email address and the email address must be in a ‘consented’ status within WKES. If recipient emails are not provided or in a ‘consented’ status, we will create delivery groups for DirectToPaper. The DeliveryGroups callback will indicate the DeliveryMode change.
  • SuppressPaperDelivery element: Expere returns a SuppressPaperDelivery element and value in the DiscreteParty section of the response. If this value is set to "true," a paper delivery group is not created for the particular discrete party containing the "true" value.
  • SmartConsentStatus: this logic utilizes a combination of DeliveryMode = ElectronicOnly or ElectronicWithEsign and the emails returned for each discrete party to verify that a "Consent" status exists in order to receive electronic packages. If any of the recipients have not consented (presence of "Consented" status), a DirectToPaper delivery mode is used. If recipient information is provided on the original request, the provided recipient information will be used for the paper delivery (DirectToPaper). If recipient information is NOT provided, delivery groupings are created based on the DirectToPaper delivery mode using DiscreteParties of the documents.
  • BRE is a parameter that can be passed in either directly at the request level or within the Recipients container when using Generate, Generate-Synchronous, or Deliver method. This parameter is used to specify the business return envelope code. Note the following:
    • If the BRE parameter is passed within the Recipients container and at the request level, the data within the Recipient container takes precedence over the request,
    • If the BRE parameter is passed at the request level only the value is used for all recipients.

Callbacks

To receive callbacks for DeliveryGroups, users can pass in the following information or have this configured at an account level:

  • AuthType: either HTTPBasic or Token authentication
  • User (username) to be passed in
  • Password to be passed in
  • Token ID value
  • URL for the initiating device.

Sample syntax below that would appear in the request:

 "callback": {
      "authorization": {
        "authType": "HTTPBasic",
        "user": "string",
        "password": "string",
        "token": "string"
      },
      "url": "string"

Related Topics