Working with Search Collection

Note
Note:  The features listed on this page are supported only in GroupDocs.Signature Cloud V1

GroupDocs.Signature Cloud REST API supports to search multiple signatures in a document. For example, you can search whether a document contains Text and Barcode Signatures at same time. To search list of signatures on document (Cells, Images, PDF, Slides or Words) Signature API provides an object SearchOptionsCollectionData that can contain one or more search options. Please, use search options which appropriate for current document format.

Search Multiple Signatures on Document

You can search multiple Signatures on Document at same time provided by fileName and document folder (if required) using following API. It expects SearchOptionsCollectionData object data in request body. You can add required search options to this object as per your document format.

It returns an object which contains document name, folder location and search result.

Resource

The following GroupDocs.Signature Cloud REST API resource has been used in the example to search multiple signatures in a document.

cURL example

curl --request POST \
--url http://api.groupdocs.cloud/v1/signature/SignedForVerificationAll.pdf/collection/search?folder#signed \
--header 'authorization: [Access Token]' \
--header 'content-type: application/json' \
--data '{ "items": [ { "barcodeTypeName": "Code39Standard", "text": "123456789012", "matchType": "Contains", "documentPageNumber": 1, "pagesSetup": { "firstPage": true, "lastPage": false, "oddPages": false, "evenPages": false, "pageNumbers": [  1 ] }, "searchAllPages": true, "OptionsType": "PdfSearchBarcodeOptionsData" }, { "documentPageNumber": 1, "pagesSetup": { "firstPage": true, "lastPage": false, "oddPages": false, "evenPages": false, "pageNumbers": [  1 ] }, "searchAllPages": true, "OptionsType": "PdfSearchDigitalOptionsData" } ] }'
{
  "signatures": [
    {
      "barcodeTypeName": "Code39Standard",
      "text": "123456789012",
      "signatureType": "PdfBarcodeSignatureData"
    },
    {
      "comments": "",
      "isValid": false,
      "digitalSignatureType": 0,
      "signTime": "2018-03-13T21:37:04",
      "signatureType": "PdfDigitalSignatureData"
    }
  ],
  "fileName": "SignedForVerificationAll.pdf",
  "folder": "pdf",
  "code": 200,
  "status": "OK"
}

SDK examples

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Search Multiple Signatures on Document at Provided URL

You can search multiple Signatures on Document at same time from specified  file URL and document folder (if required) using following API. It expects SearchOptionsCollectionData object data in request body. You can add required search options to this object as per your document format.

It returns an object which contains document name, folder location and search result.

Resource

The following GroupDocs.Signature Cloud REST API resource has been used in the example to search multiple signatures in a document at provided url.

cURL example

curl --request POST \
--url http://api.groupdocs.cloud/v1/signature/collection/verification?url#https%3a%2f%2fwww.dropbox.com%2fs%2fumokluz338w4ng7%2fone-page.docx%3fdl%3d1 \
--header 'authorization: [Access Token]' \
--header 'content-type: application/json' \
--data '{ "items": [ { "barcodeTypeName": "Code39Standard", "text": "123456789012", "matchType": "Contains", "documentPageNumber": 1, "pagesSetup": { "firstPage": true, "lastPage": false, "oddPages": false, "evenPages": false, "pageNumbers": [  1 ] }, "searchAllPages": true, "OptionsType": "PdfSearchBarcodeOptionsData" }, { "documentPageNumber": 1, "pagesSetup": { "firstPage": true, "lastPage": false, "oddPages": false, "evenPages": false, "pageNumbers": [  1 ] }, "searchAllPages": true, "OptionsType": "PdfSearchDigitalOptionsData" } ] }'
{
  "signatures": [
    {
      "barcodeTypeName": "Code39Standard",
      "text": "123456789012",
      "signatureType": "PdfBarcodeSignatureData"
    },
    {
      "comments": "",
      "isValid": false,
      "digitalSignatureType": 0,
      "signTime": "2018-03-13T21:37:04",
      "signatureType": "PdfDigitalSignatureData"
    }
  ],
  "fileName": "SignedForVerificationAll.pdf",
  "folder": "pdf",
  "code": 200,
  "status": "OK"
}

SDK examples

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.