GetDeliveredImages

Overview

The GetDeliveredImages operation retrieves the delivered PDF documents from a previously executed Select Generate And Deliver action using a respective Transaction ID

Table 1. Method
Method URL Description
GET /api/v1/Document/account/{accountId}/transaction/{transactionIdentifier}/images/{WKESTrackingId} The GET method retrieves PDF images that were shipped to the recipient.
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
WKESTrackingId string required An identifier used to track the transaction within WKES.

Sample Request: utilizes the URL of the Get method, for example: https://<ServerName>/DocumentService/api/v1/Document/account/8/transaction/1234567/images/987654.

Note the following:
  • "8" is the account Id
  • "1234567" is the transactionId
  • "987654" is the WKESTrackingId
Table 3. Responses
Code Description
200 Successful response
Example:
{
  "imageData": "VGVzdFN0cmluzw",
}
Note: the imageData element consists of base64.
400 Bad request
401 Not Authorized
403 Forbidden
500 Server error
Example:
{
  "message": "string"
}