Adding a reviewer through the REST API

roneddy | Posts: 30

Adding a reviewer through the REST API

Tuesday, November 19, 2019 at 04:45am

Hello, I have searched to find answers to this but can't seem to find them. I have seen forum posts showing how you can add a reviewer to a package using the Web (UI) however I can't seem to find the documentation on how to accomplish this via the Rest API or SDK. Ideally we would like to have a role in the package who does not have any signatures (or document accepts) but is still notified after all other signers complete. However, my understanding is that is not possible because only signers can be a part of a signer workflow. First off, is that still accurate? The posts I saw confirming that are several years old. Failing that, can we add reviewers to a package who would be notified via email and they would be able to go in and look at the current state of the documents before, during, and after the signers complete their work? If so can you please point me to documentation on how to do that using the REST API? Thank you! Ron

November 19 Created

January 21 Last Updated

5 years ago Last Reply

1 Replies

219 Views

2 Users

0 Likes

0 Links

Answered by Duo_Liang

Approved Answer

Duo_Liang | Posts: 3777

Reply to: Adding a reviewer through the REST API

Tuesday, November 19, 2019 at 05:09am

Hey Ron, Reviewer is still a signer in the package, the only difference is: reviewer doesn't have any signatures or document accepts. (You don't need to worry about the Default Consent) In below example where only Role1 has an approval, Role2 will be automatically identified as a reviewer by OneSpan Sign system.

{
   "roles":[
      {
         "id":"Role1",
         "signers":[
            {
               "email":"[email protected]",
               "firstName":"1.firstname",
               "lastName":"1.lastname",
               "company":"OneSpan Sign"
            }
         ]
      },
      {
         "id":"Role2",
         "signers":[
            {
               "email":"[email protected]",
               "firstName":"2.firstname",
               "lastName":"2.lastname",
               "company":"OneSpan Sign"
            }
         ]
      }
   ],
   "documents":[
      {
         "approvals":[
            {
               "role":"Role1",
               "fields":[
                  {
                     "page":0,
                     "top":100,
                     "subtype":"FULLNAME",
                     "height":50,
                     "left":100,
                     "width":200,
                     "type":"SIGNATURE"
                  }
               ]
            }
         ],
         "name":"Test Document"
      }
   ],
   "name":"Example Package",
   "type":"PACKAGE",
   "language":"en",
   "emailMessage":"",
   "description":"New Package",
   "status":"SENT"
}

Given the fact that reviewer is also a signer, the person is involved in the signing process, and you can expect all behaviors as a normal signer: - you can specify signing order for a reviewer, the person will only receive the activate email when it's his/her turn - reviewer will receive "email.actiavte" and "email.complete" notifications (list of all email templates here) Hope this could help! Duo