API Web Services Reference - Version 3

DocVerify Web Services Ver. 3.0

For more methods, please refer to version 2 as version 3 has updated methods from the previous version. For more information visit www.docverify.com

Sections

  • Overview
  • Requirements
  • Programmers Guide
  • Method Reference
      • AddNewDocumentESign
      • AddNewDocumentESignBase64
      • AddNewDocumentESignHTML
      • AddNewDocumentESignFromTemplate
      • AddNewDocumentESignPacket
      • AddNewDocumentESignChildAccount
      • TestDocumentXMLData
      • AddNewTemplate
      • ReplaceTemplate
      • DeleteTemplate
      • GetAuditCertificate
      • GetSignatureDetailsJSON
      • UpdateWebHookURL
      • AddNewNotaryTransaction
      • GetDocumentList


1. Overview

The DocVerify API Web Service is a commercial service which enables the sending and receiving of documents without the need to install any hardware or software. The original document to be added or E-Signed must be PDF format. Received documents and E-signed documents are also PDF format.

As an extension to sending capabilities, the DocVerify API Web Service provides facilities for retrieving status information regarding documents sent through it. The DocVerify API Web Services is available free of charge with any DocVerify account. Credits will be required to add new documents or proof notes.

The service only supports secure between the custom-programmed application and the DocVerify servers.

Signing up to DocVerify is fast and easy. Sign up now or visit www.docverify.com.

2. Requirements

Access to the Internet over 443. Support for XML Web Services. Such support is available through a wide range of tools, such as:

  • Microsoft .NET languages (VB.net, C#, ASPX)
  • Java
  • SOAP toolkits
  • etc.

Some of the API methods are also available as REST based API's. REST methods are indicated in section 4. API access requires Enterprise or higher editions.

3. Programmers Guide

3.1 Accessing the DocVerify API Web Service

3.1.1 The DocVerify API Web Service WSDL may be accessed at https://api.docverify.com/V3/?wsdl.

3.1.2 The DocVerify API Web Service may be accessed at https://api.docverify.com/V3/.

3.2 Parameters

3.2.1 Some API methods take optional or requisite parameters. Where applicable, we’ve documented those parameters. If the REST based API is available, it accepts the same parameters.

3.3 Authentication

Users must authenticate by using the assigned API Key and API Signature. To get an API Key you must have an Enterprise or higher subscription to DocVerify. After signing in, go to "My Account" --> API tab, and activate your API access.

3.42 Add a New Document and Request E-Sign

A new document can be sent and an E-Sign request for that document can be made by using the AddNewDocumentESign method.

This method is also available as a REST API.

REST address https://api.docverify.com/rest/v1/AddNewSignature

Note: All documents must be PDF's

3.43 Add a New Document and request E-Sign using a Template Document

A new E-Sign request for a template document can be made by using the AddNewDocumentESignFromTemplate method.

This method is also available as a REST API.

REST address https://api.docverify.com/rest/v1/AddNewSignatureTemplate

3.44 Test your PDF text fields with the XML Data to determine if your document will populate properly

A document and the XML data can be made by using the TestDocumentXMLData method.

This method is for testing purposed only and it will email the document back to you with the populated data in the proper fields if the docs were followed, and it was successful. If it didn't work, please refer to the Smart Tags and XML documentation, and for troubleshooting please refer to the community and online help sections.

Note: All documents must be PDF's unless stated otherwise in the method

3.45 Add a New Document and Request E-Sign - All files must be Base64 strings not binary

A new document can be sent and an E-Sign request for that document can be made by using the AddNewDocumentESignBase64 method.

Note: All documents must be Base64 string PDF's

3.46 Add a New Template to the DocVerify Library

A new template can be added to the library by using the AddNewTemplate method.

Note: All templates must be PDF's

3.47 Replace a New Template in the DocVerify Library

A template can be replaced in the library by using the ReplaceTemplate method.

Note: All templates must be PDF's

3.48 Delete a Template from the DocVerify Library

A template can deleted from the library by using the DeleteTemplate method.

3.49 Add a New Document and request E-Sign using Document Packet

A new E-Sign request for a document packet can be made by using the AddNewDocumentESignPacket method.

Note: All documents must be PDF's


3.50 Add a New Document and request E-Sign using HTML instead of PDF

A new E-Sign request for a document with HTML can be made by using the AddNewDocumentESignHTML method.

3.51 Add a New Document and request E-Sign on behalf of child account

A new E-Sign request for a document e-sign on behalf of child account can be made by using the AddNewDocumentESignChildAccount method.


3.52 Get the signature audit as a certificate PDF

An E-Sign audit certificate can be made by using the GetAuditCertificate method.


3.53 Get the signature audit trail in JSON

The E-Sign audit trail in JSON can be made by using the GetSignatureDetailsJSON method.


3.54 Update the Webhook URL for a specific account

The webhook URL is updated by using the UpdateWebHookURL method.


3.55 Add a New Notary Transaction

A new e-notary transaction can be made by using the AddNewNotaryTransaction method.

This method requires the notary to be already activated in the DocVerify system. When using this method notarizations must be done through the portal by signing in after the transaction has been created as this does not allow iframe access.


3.55 Gets a list of documents originated by a specific account

The list can be retrieved in JSON by using the GetDocumentList method.


4. Method Reference

4.3 Method Name: AddNewDocumentESign

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

4.4 Method Name: AddNewDocumentESignFromTemplate

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

4.5 Method Name: TestDocumentXMLData

Return Value: string. In case of successful submission the value will be 1 or higher. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

4.6 Method Name: AddNewDocumentESignBase64

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

4.7 Method Name: AddNewTemplate

Return Value: string. In case of successful submission the value will be 1 or higher. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

4.8 Method Name: ReplaceTemplate

Return Value: string. In case of successful submission the value will be 1 or higher. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

4.9 Method Name: DeleteTemplate

Return Value: string. In case of successful submission the value will be 1 or higher. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.0 Method Name: AddNewDocumentESignPacket

Return Value: string. In case of successful submission - the value contains the DocVerifyID or the PacketID in this case. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.1 Method Name: AddNewDocumentESignHTML

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A


5.2 Method Name: AddNewDocumentESignChildAccount

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.3 Method Name: GetAuditCertificate

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.4 Method Name: GetSignatureDetailsJSON

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.5 Method Name: UpdateWebHookURL

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.6 Method Name: AddNewNotaryTransaction

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

5.6 Method Name: GetDocumentList

Return Value: string. If there is a list it will be a JSON list. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

Appendix A - Return Codes

Results of DocVerify API Web Service

Appendix B - Error Troubleshooting

Java Errors

In some cases, Java may throw the following certificate exception: unable to find valid certification path to requested target. If this occurs it's either the GoDaddy G2 intermediary certificates have not been updated or the API certificates are not trusted. The folowing link may provide more information on how to add the certificate to Java as a Trusted cert. http://docs.oracle.com/javase/tutorial/security/toolsign/rstep2.html.