SignatureFields Resource

This resource represents all SignatureFields in the Document.

DELETE /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields

Clear all signature fields in the document.

Sample Request

DELETE http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json SignatureFieldsModel (JSON) The SignatureField(s).
application/xml SignatureFields (XML)

GET /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields

Get all SignatureFields in the Document.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json SignatureFieldsModel (JSON) The SignatureFields.
application/xml SignatureFields (XML)

DELETE /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}

Clear one signature field in the document.

Sample Request

DELETE http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/mySigField

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
fieldName path The name of the signature field to clear. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json SignatureFieldModel (JSON) The SignatureField.
application/xml SignatureField (XML)

GET /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}

Get one SignatureField in the Document.

Sample Request

GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/mySigField

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
fieldName path The name of the signature field to get. n/a
filePath path Path to the file to operate on. n/a
Response Body
media type data type description
application/json SignatureFieldModel (JSON) The SignatureField.
application/xml SignatureField (XML)

PUT /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}

Create a new signature field in the document.

The message body is a Field JSON object.

Sample Request

 PUT http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/mySigField
 Content-Type: application/json
 (sample JSON in request body)
 {
   "widget":[
   {
     "pageIndex":0,
     "rectangle":
     {
       "x":100,
       "y":100,
       "width":200,
       "height":50
     }
   }]
 }

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
fieldName path The name of the new field. n/a
filePath path Path to the file to operate on. n/a
Request Body
media type data type description
application/json FieldModel (JSON) The signature field in JSON format. Defaults are as follows: pageIndex=0, x=0, y=0, width=200, height=50.
application/xml Field (XML)
Response Body
media type data type description
application/json FieldModel (JSON) The SignatureField.
application/xml Field (XML)

POST /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}/default-signature

Sign the signature field with the default settings.

Sample Request

POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/mySigField/default-signature

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
fieldName path n/a
filePath path Path to the file to operate on. n/a
id query n/a
Response Body
media type data type description
application/json SignatureFieldModel (JSON) The SignatureField.
application/xml SignatureField (XML)

POST /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}/signature

Sign the signature field.

The message body is Multipart/Form-Data consisting of a DigitalID and a PKCS12 file.

Sample Request

 POST http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/fields/signature-fields/mySigField/signature
 Content-Type: multipart/form-data
 (pfx or p12 file as "file" part)
 (sample JSON as "digitalID" part)
 {
   "keystorePassword":"password", 
   "keyAlias":"alias", 
   "keyPassword":"password", 
   "certifyingSignature":true, 
   "certifyingPermissions":3, 
   "signLocation" : "US", 
   "signReason" : "I approve this document", 
   "signContactInformation" : "me@example.com"
 }

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
digitalID formdata The DigitalID in json format. n/a
file formdata The PKCS12 file. n/a
X-Qoppa-DocumentPassword header The document's password. n/a
fieldName path n/a
filePath path Path to the file to operate on. n/a
Request Body
media type data type
multipart/form-data (custom)
Response Body
media type data type description
application/json SignatureFieldModel (JSON) The SignatureField.
application/xml SignatureField (XML)