ValidateDocument

The ValidateDocument operation can be used to validate a PDF document that was signed using Nintex eSign to ensure that it has not been tampered with.

This operation requires the binary data of the pdf file document formatted as a Base64 encoded string.

The result from the operation will contain the following attributes:

  • Code - a machine-readable result code indicating the result of the document validation operation

  • DocumentName - the name of the document when it was created in Nintex eSign

  • Originator - the name of the user that originated the document

  • OriginatingCompany - the account-setting defined name of the company that originated the document

  • DateCompleted - the date when document signing was completed

  • Description - a human-readable description of the result of the document validation operation

The possible values for the result code include the following:

  • COV - Completed and valid

  • COI - Completed, but invalid (may have been tampered with)

  • INC - Incomplete

  • CAN - Cancelled

  • DCN - Declined

  • EXP - Expired

  • DFI - Originated in a different instance of Nintex eSign

  • NMD - No matching document found

  • NAS - Not an Nintex eSign document

  • CPT - Document is corrupt

  • EGA - Error extracting Nintex eSign metadata attributes

  • ERL - Error loading document

Sample XML

Copy 
<?xml version="1.0" encoding="utf-8"?> 
<ValidateDocument xmlns="https://www.assuresign.net/Services/DocumentNOW/ValidateDocument">
  <ValidateDocumentQuery>
    <FileDocument FileType="PDF">
      <Data>ZGF0YQ==</Data>
    </FileDocument>
  </ValidateDocumentQuery>
</ValidateDocument>

The SOAP Action header is

Copy 
https://www.assuresign.net/Services/DocumentNOW/ValidateDocument/IValidateDocumentService/ValidateDocument

A response will return a single document validation result:

Copy 
<?xml version="1.0" encoding="utf-8"?> 
<ValidateDocumentResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/ValidateDocument">
  <ValidateDocumentQueryResult>
    <ValidationResult Code="COV" DocumentName="Test Document" Originator="John Doe" OriginatingCompany="ABC Company" DateCompleted="2012-05-30 12:47:41 (UTC)" Description="The document you uploaded was recognized as an AssureSign document and no indication was found that it has been tampered with." />
  </ValidateDocumentQueryResult>
</ValidateDocumentResponse>

The ValidateDocumentQueryResult should be checked for the presence of an Exceptions element, which may contain multiple ValidateDocumentException items.