SearchSettings

On this page

SearchSettings data structure used as input parameters of Search API method.

SearchSettings example
{
  "FileInfo": {
    "FilePath": "string",
    "StorageName": "string",
    "VersionId": "string",
    "Password": "string"
  },
  "Options":
   [
    {
        "SignatureType": "Barcode",
        "Page": 1,
        "Text": "123",
        "BarcodeType": "Code128",
        "MatchType": "Contains"
    }
   ]
 }
SearchSettings fields
NameDescriptionAPI Version
FileInfo.FilePathThe path of the document, located in the storage. Required.
FileInfo.StorageNameStorage name
FileInfo.VersionIdFile version Id
FileInfo.PasswordPassword for password-protected document to be signed.
OptionsArray with at least one SearchOptions that specifies search options to provide search in the document for different signatures

On this page