▲ Top

File Attachments

This section describes the following services that pertain to file attachments:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Download an Attachment

GET /packages/{packageId}/attachment/{attachmentUid}

Description

Download an attachment.

Resource Information

HTTP Method GET
Resource Family attachment
Authentication Authentication Tokens
Content-type application/octet-stream
Accept application/json

Example Request

GET https://sandbox.e-signlive.com/api/packages/c6e0dbca-3b74-4eea-a226-4936c9d8b017/attachment/H6ZWDn0i2xsW

Response Payload

[document.pdf]

Download All Attachments as a Zip File

GET /packages/{packageId}/attachment/zip

Description

Download all attachments as a zip file.

Resource Information

HTTP Method GET
Resource Family attachment
Authentication Authentication Tokens
Content-type application/zip
Accept application/zip

Example Request

GET https://sandbox.e-signlive.com/api/packages/c6e0dbca-3b74-4eea-a226-4936c9d8b017/attachment/zip

Response Payload

[document.zip]

Download All Attachments as a Zip File for a Role in a Package

GET /packages/{packageId}/attachment/zip/{roleId}

Description

Download all attachments as a zip file for a Role in a package.

Resource Information

HTTP Method GET
Resource Family attachment
Authentication Authentication Tokens
Content-type application/zip
Accept text/html

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

GET https://sandbox.e-signlive.com/api/packages/c6e0dbca-3b74-4eea-a226-4936c9d8b017/attachment/zip/56863269-f203-4a6e-ba67-2e6490f1fd2c

Response Payload

[document.zip]

Upload an Attachment

POST /packages/{packageId}/attachment/{attachmentUid}

Description

Upload an attachment.

Resource Information

HTTP Method POST
Resource Family attachment
Authentication Required
Content-type text/html
Accept text/html

Example Request

POST https://sandbox.e-signlive.com/api/packages/c6e0dbca-3b74-4eea-a226-4936c9d8b017/attachment/H6ZWDn0i2xsW