Verification Options Objects

Page contains description for Verification Options objects and object properties

VerifyOptionsCollectionData Object

Provides list of options for documents verification.

Example VerifyOptionsCollectionData object

{
  "items": [
    {
  "items": [
    {
      "barcodeTypeName": "Code39Standard",
      "matchType": "Contains",
      "text": "123456789012",
      "verifyAllPages": true,
      "isValid": false,
      "documentPageNumber": 3,
      "pagesSetup": {
        "firstPage": false,
        "lastPage": true,
        "oddPages": false,
        "evenPages": true,
        "pageNumbers": [
          1,
          3,
          5
        ]
      }
    },
    {
      "password": "1234567890",
      "certificateGuid": "certificates\SherlockHolmes.pfx",
      "isValid": false,
      "documentPageNumber": 3,
      "pagesSetup": {
        "firstPage": false,
        "lastPage": true,
        "oddPages": false,
        "evenPages": true,
        "pageNumbers": [
          1,
          3,
          5
        ]
      }
    }
  ]
}

VerifyOptionsCollectionData Object Fields (Click here to expand)

NameTypeDescription
ItemsListList of Verify Options records.

CellsVerifyTextOptionsData Object

Provides options to verify Text Signature in Cells Documents.

Example CellsVerifyTextOptionsData object

{
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "CellsVerifyTextOptionsData"
 }

CellsVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
TextstringText of Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “CellsVerifyTextOptionsData”. This property is set automatically when using SDK classes.

PdfVerifyTextOptionsData

Provides options to verify Text Signature in Pdf Documents.

Example PdfVerifyTextOptionsData object

{
  "SignatureID" : 1001,
  "SignatureImplementation" : "Stamp",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "PdfVerifyTextOptionsData"
 }

PdfVerifyTextOptions Object Fields (Click here to expand)

NameTypeDescription
SignatureIDintunique identifier of Text Signature for Stamp Text signature implementation
SignatureImplementationenumSpecifies type of Signature implementation to verify
TextstringText of Signature. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “PdfVerifyTextOptionsData”. This property is set automatically when using SDK classes.

SlidesVerifyTextOptionsData Object

Provides options to verify Text Signature in Slides Documents.

Example SlidesVerifyTextOptionsData object

{
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "SlidesVerifyTextOptionsData"
 }

SlidesVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
TextstringText of Signature. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “SlidesVerifyTextOptionsData”. This property is set automatically when using SDK classes.

WordsVerifyTextOptionsData Object

Provides optionsto verify Text Signature in Words Documents.

Example WordsVerifyTextOptionsData object

{
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "WordsVerifyTextOptionsData"
 }

WordsVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
TextstringText of Signature to verify
DocumentPageNumberintSpecifies document page number to add Text Signature. Default value is 1.
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
SheetNumberintSpecifies document-sheet page number to add Text Signature.
OptionsTypestringThe class name of options object, should always contains value “WordsVerifyTextOptionsData”. This property is set automatically when using SDK classes.

CellsVerifyDigitalOptionsData Object

Provides options to verify Digital Signature in Cells Documents.

Example CellsVerifyDigitalOptionsData object

{
  "DocumentPageNumber": 1,
  "Password" : "1234567890",
  "CertificateGuid": "mrjohn.smith.crt",
  "Comments" : "verified data",
  "SignDateTimeFrom" : "1/12/2017",
  "SignDateTimeTo" : "12/12/2017",
  "OptionsType": "CellsVerifyDigitalOptionsData"
 }

CellsVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
TextstringText of Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “CellsVerifyDigitalOptionsData”. This property is set automatically when using SDK classes.

Provides options to verify Digital Signature in Pdf Documents.

Example PdfVerifyDigitalOptionsData object

{
  "DocumentPageNumber": 1,
  "Password" : "1234567890",
  "CertificateGuid": "mrjohn.smith.crt",
  "Reason" : "reason",
  "Contact" : "mrJohn",
  "Location" : "Storage",
  "OptionsType": "PdfVerifyDigitalOptionsData"
 }

PdfVerifyDigitalOptionsData Object Fields (Click here to expand)

NameTypeDescription
SignatureIDintunique identifier of Text Signature for Stamp Text signature implementation
SignatureImplementationenumSpecifies type of Signature implementation to verify
TextstringText of Signature. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “PdfVerifyDigitalOptionsData”. This property is set automatically when using SDK classes.

WordsVerifyDigialOptionsData Object

Provides options to verify Digital Signature in Words Documents.

Example WordsVerifyDigitalOptionsData object

{
  "DocumentPageNumber": 1,
  "Password" : "1234567890",
  "CertificateGuid": "mrjohn.smith.crt",
  "Comments" : "verified data",
  "SignDateTimeFrom" : "1/12/2017",
  "SignDateTimeTo" : "12/12/2017",
  "OptionsType": "WordsVerifyDigitalOptionsData"
 }

WordsVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
TextstringText of Signature to verify
DocumentPageNumberintSpecifies document page number to add Text Signature. Default value is 1.
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
SheetNumberintSpecifies document-sheet page number to add Text Signature.
OptionsTypestringThe class name of options object, should always contains value “WordsVerifyDigitalOptionsData”. This property is set automatically when using SDK classes.

CellsVerifyBarcodeOptionsData Object

Provides options to verify Barcode Signature in Cells Documents.

Example CellsVerifyBarcodeOptionsData object

{
  "BarcodeTypeName" : "Code128",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "CellsVerifyBarcodeOptionsData"
 }

CellsVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
BarcodeTypeNamestringBarcode encode type name to verify on document page(s). List of supported Barcode encode type names could be found in Barcode Resources
MatchTypeenumSpecifies Text matching logic. See TextMatchTypeData
TextstringText of Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “CellsVerifyBarcodeOptionsData”. This property is set automatically when using SDK classes.

ImagesVerifyBarcodeOptionsData Object

Provides options to verify Barcode Signature in Images Documents.

Example ImagesVerifyBarcodeOptionsData object

{
  "barcodeTypeName": "Code39Standard",
  "matchType": "Contains",
  "text": "123456789012",
  "verifyAllPages": true,
  "isValid": false,
  "documentPageNumber": 3,
  "pagesSetup": {
    "firstPage": false,
    "lastPage": true,
    "oddPages": false,
    "evenPages": true,
    "pageNumbers": [
      1,
      3,
      5
    ]
  },
  "optionsType": "ImagesVerifyBarcodeOptionsData"
}

CellsVerifyTextOptionsData Object Fields (Click here to expand)

NameTypeDescription
BarcodeTypeNamestringBarcode encode type name to verify on document page(s). List of supported Barcode encode type names could be found in Barcode Resources
TextstringOptional. Specifies text to search in Barcodes. If value is not set there will be no Text criteria.
MatchTypeenumSpecifies Text matching logic. See TextMatchTypeData
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “CellsVerifyBarcodeOptionsData”. This property is set automatically when using SDK classes.

Provides options to verify Barcode Signature in Pdf Documents.

Example PdfVerifyBarcodeOptionsData object

{
  "BarcodeTypeName" : "Code128",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "PdfVerifyBarcodeOptionsData"
 }

PdfVerifyBarcodeOptionsData Object Fields (Click here to expand)

NameTypeDescription
BarcodeTypeNamestringBarcode encode type name to verify on document page(s). List of supported Barcode encode type names could be found in Barcode Resources
MatchTypeenumSpecifies enumeration of possible Barcode Text match - Exact match, Starts With, Ends With, Contains
TextstringText of Signature. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “PdfVerifyBarcodeOptionsData”. This property is set automatically when using SDK classes.

SlidesVerifyBarcodeOptionsData Object

Provides options to verify Barcode Signature in Slides Documents.

Example SlidesVerifyBarcodeOptionsData object

{
  "BarcodeTypeName" : "Code128",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "SlidesVerifyBarcodeOptionsData"
 }

SlidesVerifyBarodeOptionsData Object Fields (Click here to expand)

NameTypeDescription
BarcodeTypeNamestringBarcode encode type name to verify on document page(s). List of supported Barcode encode type names could be found in Barcode Resources
MatchTypeenumSpecifies enumeration of possible Barcode Text match - Exact match, Starts With, Ends With, Contains
TextstringText of Signature. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify Text Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “SlidesVerifyBarcodeOptionsData”. This property is set automatically when using SDK classes.

WordsVerifyBarcodeOptionsData Object

Provides options to verify Barcode Signature in Words Documents.

Example WordsVerifyBarcodeOptionsData object


{
  "BarcodeTypeName" : "Code128",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "WordsVerifyBarcodeOptionsData"
 }

NameTypeDescription
BarcodeTypeNamestringBarcode encode type name to verify on document page(s). List of supported Barcode encode type names could be found in Barcode Resources
MatchTypeenumSpecifies enumeration of possible Barcode Text match - Exact match, Starts With, Ends With, Contains
TextstringText of Signature to verify
DocumentPageNumberintSpecifies document page number to add Text Signature. Default value is 1.
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
SheetNumberintSpecifies document-sheet page number to add Text Signature.
OptionsTypestringThe class name of options object, should always contains value “WordsVerifyBarcodeOptionsData”. This property is set automatically when using SDK classes.

CellsVerifyQRCodeOptionsData Object

Provides options to verify QRCodeSignature in Cells Documents.

Example CellsVerifyQRCodeOptionsData object

{
  "QRCodeTypeName" : "QRCode",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "CellsVerifyQRCodeOptionsData"
 }

CellsVerifyQRCodeOptionsData Object Fields (Click here to expand)

NameTypeDescription
QRCodeTypeNamestringQR-Code encode type name to verify on document page(s). List of supported QR-Code encode type names could be found in QR-Code Resources
MatchTypeenumSpecifies enumeration of possible QR-Code Text match - Exact match, Starts With, Ends With, Contains
TextstringText of QR-Code Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify QR-Code Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “CellsVerifyQRCodeOptionsData”. This property is set automatically when using SDK classes.

ImagesVerifyQRCodeOptionsData Object

Provides options to verify QRCodeSignature in Images Documents.

Example ImagesVerifyQRCodeOptionsData object

{
  "qrCodeTypeName": "Aztec",
  "matchType": "Contains",
  "text": "John Smith",
  "verifyAllPages": true,
  "isValid": false,
  "documentPageNumber": 3,
  "pagesSetup": {
    "firstPage": false,
    "lastPage": true,
    "oddPages": false,
    "evenPages": true,
    "pageNumbers": [
      1,
      3,
      5
    ]
  },
  "optionsType": "ImagesVerifyQRCodeOptionsData"
}

ImagesVerifyQRCodeOptionsData Object Fields (Click here to expand)

NameTypeDescription
QRCodeTypeNamestringQR-Code encode type name to verify on document page(s). List of supported QR-Code encode type names could be found in QR-Code Resources
MatchTypeenumSpecifies Text matching logic. See TextMatchTypeData
TextstringText of QR-Code Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify QR-Code Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “ImagesVerifyQRCodeOptionsData”. This property is set automatically when using SDK classes.

Provides options to verify QRCode Signature in Pdf Documents.

Example PdfVerifyQRCodeOptionsData object

{
  "QRCodeTypeName" : "QRCode",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "PdfVerifyQRCodeOptionsData"
 }

PdfVerifyQRCodeOptionsData Object Fields (Click here to expand)

NameTypeDescription
QRCodeTypeNamestringQR-Code encode type name to verify on document page(s). List of supported QR-Code encode type names could be found in QR-Code Resources
MatchTypeenumSpecifies enumeration of possible QR-Code Text match - Exact match, Starts With, Ends With, Contains
TextstringText of QR-Code Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify QR-Code Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “PdfVerifyQRCodeOptionsData”. This property is set automatically when using SDK classes.

SlidesVerifyQRCodeOptionsData Object

Provides options to verify QRCodeSignature in Slides Documents.

Example SlidesVerifyQRCodeOptionsData object

{
  "BarcodeTypeName" : "Code128",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "SlidesVerifyQRCodeOptionsData"
 }

SlidesVerifyQRCodeOptionsData Object Fields (Click here to expand)

NameTypeDescription
QRCodeTypeNamestringQR-Code encode type name to verify on document page(s). List of supported QR-Code encode type names could be found in QR-Code Resources
MatchTypeenumSpecifies enumeration of possible QR-Code Text match - Exact match, Starts With, Ends With, Contains
TextstringText of QR-Code Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify QR-Code Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “SlidesVerifyQRCodeOptionsData”. This property is set automatically when using SDK classes.

[WordsVerifyQRCodeOptionsData Object](“WordsVerifyQRCode OptionsData”)

Provides options to verify QR-Code Signature in Words Documents.

Example WordsVerifyQRCodeOptionsData object


{
  "QRCodeTypeName" : "QRCode",
  "MatchType" : "Exact",
  "DocumentPageNumber": 1,
  "Text": "John Smith",
  "VerifyAllPages" : true,
  "OptionsType": "WordsVerifyQRCodeOptionsData"
 }

NameTypeDescription
QRCodeTypeNamestringQR-Code encode type name to verify on document page(s). List of supported QR-Code encode type names could be found in QR-Code Resources
MatchTypeenumSpecifies enumeration of possible QR-Code Text match - Exact match, Starts With, Ends With, Contains
TextstringText of QR-Code Signature to verify. Default value is empty.
DocumentPageNumberintSpecifies document-sheet page number to verify QR-Code Signature. Parameter is optional. if value is not set program will try to find on any page
PagesSetupstructSpecifies Page Setting to define separate pages to process. See PagesSetupData
VerifyAllPagesboolThe flag to verify all pages in document
OptionsTypestringThe class name of options object, should always contains value “WordsVerifyQRCodeOptionsData”. This property is set automatically when using SDK classes.