Skip to main content
Kofax

Using SignDoc Standard's REST API: Retreiving completed signing packages without the default cover page

Article # 3034824 - Page views: 56

Issue

Completed signing packages are forwarded to signing package recipients with a cover page.  As a SignDoc user (who is the signing package creator) I want to deliver completed signing packages to my package recipients (or others) without the standard cover page. 

NOTE: The SignDoc REST API implements swagger (https://swagger.io/) to document its API.

Solution

Prerequisites
  • As a signing package creator, I need to generate an API key (https://docshield.kofax.com/SD/en_US...ces.html?h=api) to access the SignDoc REST API.
  • Signing packages should be completed (all signing recipients have signed) and available to me as a signing package creator.

  • As a signing package creator I will need and understand how to use a REST Client.  I will use Postman (https://www.postman.com/) as my REST Client for this solution, although I could choose other REST clients to use, instead of Postman.

Process
  • As a signing package creator I can access the SignDoc REST API (the swagger interface) by navigating to http(s)://SERVER_NAME:PORT/cirrus/swagger and copying the generated API key (from the prerequisites) in the X-Auth-Token or API-Key field, then clicking on the Explore button - my API key is now initialized and I am free to use the REST API without restrictions. 
    However, the swagger interface is used primarily to document the SignDoc REST API and test the SignDoc REST API functionality.
    Under most circumstances a REST Client should be used to access the swagger interface.

  • Now that I understand (by reviewing the SignDoc REST API and testing its functionality) how to use the SignDoc REST API, I am ready to use Postman.

  • To retrieve (download) a specific document from a completed signing package execute the GET method: /rest/v7/packages/{packageid}/documents/{documentid}/content. Example below.  Required parameters: packageId and documentId

  • In this example the:

    • parameter packageId is c199959d-0eaa-4688-880c-051193366f6e
    • parameter documentId is fe25e3e0-e96c-4c69-a93e-30625dcadf57
    • API-Key is bf387b39-af0a-4fef-8b70-2f4ab3fda2ba

clipboard_e4198e6e7f460d1d4ca2992b1b26ffbfd.png

The response body will return to Postman a representation of my signed document.  Click on Save Response (below the Send button) and save the response as a PDF - example: example.pdf

===============

  • To retrieve (download to a zip file) all documents from a completed signing package execute the GET method: /rest/v7/packages/{packageid}/documents. Example below.  Required parameters: packageId
  • In this example the:
    • parameter packageId is c199959d-0eaa-4688-880c-051193366f6e
    • API-Key is bf387b39-af0a-4fef-8b70-2f4ab3fda2ba

clipboard_e001fc6dbb76b1c3fe215e30aac4d9a88.png

The response body will return to Postman a representation of my signed documents.  Click on Save Response (below the Send button) and save the response as a ZIP file - example: example.zip

Level of Complexity 

High

Applies to  

Product Version Build Environment Hardware
Kofax SignDoc 2.1.x, 2.2, 3.0.x     Windows, Linux AMD, Intel

  • Was this article helpful?