Document types

Hi Naresh,

Below example JSON creates you a package with three documents with types of Sign, Accept and View. All differences are at the "documents" > "approvals" node.

{
  "roles": [
    {
      "id": "Signer1",
      "type": "SIGNER",
      "signers": [
        {
          "email": "[email protected]",
          "firstName": "John",
          "language": "en",
          "lastName": "Smith",
          "id": "Signer1"
        }
      ],
      "name": "Signer1"
    }
  ],
  "status": "SENT",
  "description": "",
  "language": "en",
  "documents": [
    {
      "id": "Doc1-Sign",
      "approvals": [
        {
          "role": "Signer1",
          "id": "approval1",
          "fields": [
            {
              "binding": null,
              "id": "signature1",
              "page": 0,
              "top": 216,
              "subtype": "FULLNAME",
              "left": 315,
              "width": 165,
              "height": 37,
              "type": "SIGNATURE",
              "value": "",
              "name": ""
            }
          ]
        }
      ],
      "index": 1,
      "name": "Doc1-Sign"
    },
    {
      "id": "Doc2-Accept",
      "approvals": [
        {
          "role": "Signer1",
          "id": "approval2"
        }
      ],
      "index": 2,
      "name": "Doc2-Accept"
    },
    {
      "id": "Doc3-View",
      "approvals": [],
      "index": 3,
      "name": "Doc3-View"
    }
  ],
  "emailMessage": "",
  "type": "PACKAGE",
  "name": "Example Package"
}

Regarding to the download options, "GET /api/pakcages/{packageId}/documents/zip" API will always return documents of ALL three types, this is because we suggest our clients to download and archive all documents no matter if there's e-signatures on it, in stead of maintaining it on OneSpan Sign server. And if you only want particular signed documents, you can download them separately (GET /api/pakcages/{packageId}/documents/{documentId}/pdf) and programmatically compress them in a zip file.

Duo

Thanks for the information Duo.

We are able to create package with 3 types of documents(View, Sign and Accept) as explained above and it is working fine for 1 signer.

It seems that in case of multiple signers, and document type as Accept, only signer 1 is able to accept the document and rest all other signers have view only access to it. 

How can we create a package where all signers can accept the document(Document type is accept) ?

Thanks,

Naresh

Hi Naresh,

In that case, you need to add approvals for all signers like below:

  {
      "id": "Doc2-Accept",
      "approvals": [
        {
          "role": "Signer1",
          "id": "approval2"
        },

        {
          "role": "Signer2",
          "id": "approval3"
        },

        {
          "role": "Signer2",
          "id": "approval4"
        }
      ],
      "index": 2,
      "name": "Doc2-Accept"
    },

Duo