Jump to main content

# GetDeliverySetup

## Overview

The GetDeliverySetup operation is used to retrieve the delivery setup information for a transaction.

Table 1. Method
Method | URL | Description
--- | --- | ---
GET | /api/v1/Document/account/{accountId}/deliver/{transactionId} | The GET method retrieves delivery setup for a given generate request.

Table 2. Parameters
Name | Type | Constraints | Description
--- | --- | --- | ---
accountId | integer | required | Account associated with the delivery setup for a particular financial institution.
transactionId | integer | required | An identifier assigned by the Expere Document Services solution for the document request event. This ID is used for request tracking purposes

## Sample Request

    {
      "request": {
        "transactionIdentifier": "string",
        "passthroughIdentifier": "string",
        "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"
        }
      }
    }

## Sample Response

    {
      "deliverySetupSuccess": "Successful",
      "passthroughIdentifier": "string",
      "message": "string",
      "transactionIdentifier": "string",
      "deliveryMode": "ImageOnly",
      "deliveryGroup": [
        {
          "name": "string",
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "countryCode": "string",
          "mailingMethod": "USPSFirstClass",
          "emailAddresses": [
            "string"
          ],
          "discretePartyId": "string",
          "wkesId": "string",
          "groupId": "string",
          "documents": [
            {
              "docID": "string",
              "instanceDisplayName": "string"
            }
          ]
        }
      ]
    }