Attachment requirements

Hi Gabriel,

Thanks for your post!

It is expected that if a signer attachment is required, the transaction will be forced to turn on review before completion ("autocomplete":false). This is designed for the sender to manually check the uploaded attachment(s) and determine if to mark the transaction as completed or decline the attachments.

If you want to programmatically mark the transaction as completed, use below API:
PUT /api/packages/{packageId}

{"status":"COMPLETED"}

Duo

Hi Duo.
thanks for your answer, but is it possible to force with "autocomplete: true" in the attachments section?
I try to insert this value.

"attachmentRequirements": [ { "description": "Por favor, suba una copia escaneada de su DNI", "required": true, "id": "gabrieltestattach123456", "data": null, "status": "INCOMPLETE", "comment": "", "name": "Fotocopia DNI" } ],

Hi Gabriel,

Unfortunately, no, I think as long as there's a required attachment, the transaction will be forced to turn on "autocomplete":false and you won't be able to edit it.

Duo

Hi Duo,

I have a follow up question. Is it possible to declare during the package creation instance that an extra file should be attached after signing the package documents? Or I have to make 2 separate calls, 1 for package creation, 1 for setting attachment to the role

Hi Vinh Nguyen,

You can declare signer attachment requirement in the trasnaction creation call, see below example:
{
 "roles": [
   {
     "id": "Signer1",
     "signers": [
       {
         "email": "[email protected]",
         "firstName": "1.firstname",
         "lastName": "1.lastname",
         "company": "OneSpan Sign"
       }
     ],
     "attachmentRequirements": [
       {
         "description": "Please upload a scanned copy of your driver's license.",
         "required": true,
         "name": "Driver's license"
       }
     ]
   }
 ],
 "documents": [
   {
     "approvals": [
       {
         "role": "Signer1",
         "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",
 "autocomplete": true,
 "status": "SENT"
}

Duo