Search Digital Signature

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

GroupDocs.Signature Cloud REST API supports to search Digital signatures in supported document formats. It provides method to search Digital Signature in Document Pages with different options by using Search Options Object data in request body.

Search Digital Signature

You can search Digital Signature on Document provided by fileName and document folder (if required) using following API. It expects Search Options Object data in request body.

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 Digital signature in a document.

cURL example

curl --request POST \
--url http://api.groupdocs.cloud/v1/signature/SignedForVerificationAll.xlsx/digital/search?folder#signed \
--header 'authorization: [Access Token]' \
--header 'content-type: application/json' \
--data '{ "documentPageNumber": 1, "pagesSetup": { "firstPage": true, "lastPage": false, "oddPages": false, "evenPages": false, "pageNumbers": [ 1 ] }, "searchAllPages": true, "OptionsType": "CellsSearchDigitalOptionsData" }'
{
  "signatures": [
    {
      "comments": "Test comment",
      "isValid": false,
      "digitalSignatureType": 0,
      "signTime": "2017-01-25T10:41:54Z",
      "signatureType": "CellsDigitalSignatureData"
    }
  ],
  "fileName": "SignedForVerificationAll.xlsx",
  "folder": "cells",
  "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 Digital Signature in a Document at Provided URL

You can search Digital Signature for document at provided URL with Search Options by using following API. It retrieves file from specified URL and tries to detect file type when fileName parameter is not specified.

It expects Search Options object data in request body. Based on passed Search Options settings proceeds with Document search, it returns object which contains result of searching process. The field Signatures keeps list of objects which represents found signatures like WordsDigitalSignatureData.

Resource

The following GroupDocs.Signature Cloud REST API resource has been used in the example to search Digital signature in a document at provided URL.

cURL example

curl --request POST \
--url http://api.groupdocs.cloud/v1/signature/digital/search?url#https%3a%2f%2fwww.dropbox.com%2fs%2fumokluz338w4ng7%2fone-page.docx%3fdl%3d1 \
--header 'authorization: [Access Token]' \
--header 'content-type: application/json' \
--data '{ "DocumentPageNumber": 1,  "Password" : "1234567890",  "CertificateGuid": "mrjohn.smith.crt",  "OptionsType" : "WordsSearchDigitalOptionsData" }'
{
  "fileName": "one-page.docx",
  "folder": "Output",
  "Code": "OK",
  "Status" : "OK",
  "Signatures" : [
    { Comments: "Comment#1", IsValid: "true", SignatureType: "CryptoApi", SignTime: "2017-01-01" },
    { Comments: "Comment#2", IsValid: "false", SignatureType: "XmlDsig", SignTime: "2017-10-10" }
    ]
}

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.