← FlexAPI Documentation / API Calls / ConfirmDownload

ConfirmDownload

The ConfirmDownload method confirms that a DownloadDocument call successfully returned all of the signed (acted-upon) PDFs and the accompanying Audit Trail. This call is REQUIRED. It tells SIGNiX that, now that your application has the documents, SIGNiX can safely archive or delete transaction data.

ConfirmDownload completes the download process by changing the transaction status from "Complete" to "PendingDeletion". See Retention and deletion on the DownloadDocument page for details. Call it only after your application has stored the downloaded documents, not immediately after the download call.

Before you call

Do not send a Demo element. It is required on SubmitDocument only; sending it here is a schema error.
Keep CustInfo minimal. Credentials only; no Workgroup is needed.
Check StatusCode, not just the HTTP status. An HTTP 200 can still carry a non-zero StatusCode.
Confirm once, and only after your documents are safely stored. Confirming moves the transaction to "PendingDeletion" and starts the retention clock, including any DelDocsAfter period set at submission. Confirming early risks losing documents you have not yet stored.
If the confirm call fails or times out, retry it. If your storage step failed, go back and download again instead of confirming.
Full sequence: see Download, store, confirm on the DownloadDocument page.

ConfirmDownload - annotated request

<?xml version="1.0" ?>
<ConfirmDownloadRq xmlns="urn:com:signix:schema:sdddc-1-1">

  <CustInfo> <!-- Occurs once only -->

    <!-- Assigned by SIGNiX when the Client is set up. All case sensitive. -->
    <Sponsor>YOUR_SPONSOR</Sponsor>
    <Client>YOUR_CLIENT</Client>
    <UserId>YOUR_USER</UserId>
    <Pswd>YOUR_PASSWORD</Pswd>

    <!-- Identifies the billing party for this transaction. Primarily used by Clients that need to
         differentiate between divisions, end users and so on, to bill them in return or allocate
         cost for reporting. Appears on SIGNiX billing reports. Optional. Can be left blank.
         Max length 50. -->
    <BillingRef>SmithRealty</BillingRef>

  </CustInfo>

  <Data> <!-- Occurs once only -->

    <!-- Identifies the document set with an opaque identifier. This is the same DocumentSetID
         returned in the SubmitDocument response. The TransactionID can also be used here. -->
    <DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID>

  </Data>

</ConfirmDownloadRq>

ConfirmDownload - annotated response

<?xml version="1.0" ?>
<ConfirmDownloadRs xmlns="urn:com:signix:schema:sdddc-1-1">

  <Status> <!-- Occurs once only -->
    <StatusCode>0</StatusCode> <!-- One of the numeric SC_* values -->
    <StatusDesc>success</StatusDesc> <!-- Human-readable version of StatusCode -->
  </Status>

</ConfirmDownloadRs>

ConfirmDownload

On this page

Before you call