API Web Services Reference - Version 2
DocVerify Web Services Ver. 2.0
For more information visit www.docverify.com
Sections
- Overview
- Requirements
- Programmers Guide
- Method Reference
- AddNewDocument
- AddNewDocumentESign. Please refer to Version 3.0
- AddNewDocumentESignFromTemplate. Please refer to Version 3.0
- AddNewDocumentESignPacket
- AddNewNotaryJournalEntry
- AddNewNotaryRequestDocument
- AddProofNote
- CancelESign
- GetDocumentStatus
- GetDocument
- GetSignatureStatus
- GetDocumentDetails
- GetDocumentDetailsJSON
- GetENotaryList
- GetESignListID
- GetEasySignID
- GetPacketDocs
- GetSignatureDetailsJSON
- GetSignatureFormData
- GetTemplateList
- GetSchedule
- GetVersion
- ValidateDocument
- Appendix A - Error Codes
- Appendix B - Error Troubleshooting
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/V2/?wsdl.
3.1.2 The DocVerify API Web Service may be accessed at https://api.docverify.com/V2/.
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.41 Add a New Document
A new document can be sent by using the AddNewDocument method.
Note: All documents must be PDF's
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
REST returns JSON response.
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 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.45 Add a new Notary Electronic Journal. You must be a commissioned notary, and active as a Notary is the DocVerify system.
Add a new notary e-journal entry by calling the AddNewNotaryJournalEntry method. Some of the information entered must be verified by the notary, and the notary will be able to change or modify the data entered here.
Note: The edition must have the E-Journal feature.
3.46 Add a new DocVerify Notary Request document to any active DocVerify authorized notary
Add a new notary request by calling the AddNewNotaryRequestDocument method. Some of the information entered must be verified by the notary, and the notary will be able to change or modify the data entered here.
3.47 Add a New DocVerify Proof Note
A new proof note can be sent by using the AddProofNote method.
3.48 Cancel E-Signature document request
A cancel E-Sign can be sent by using the CancelESign method.
3.49 Get Document Status
Get the current document status GetDocumentStatus method.
3.50 Get Document
Get the document for download GetDocument method.
3.51 Get Signature Status
Get the current signature status GetSignatureStatus method.
3.52 Returns Document Details
Details about a certain DocVerify document that you own, are being shared with you or are being requested for electronic signatures can be retrieved by calling the GetDocumentDetails method.
3.53 Returns Document Details in JSON
Details about a certain DocVerify document that you own, are being shared with you or are being requested for electronic signatures returned in JSON can be retrieved by calling the GetDocumentDetailsJSON method.
3.54 Returns a list of commissioned and DocVerify authorized electronic notaries
Get a complete list of the DocVerify authorized notaries by each state by calling the GetENotaryList method.
3.55 Returns a list of E-Sign documents that are either out to be sign or signed.
Get a list of the DocVerify E-Signature documents by calling the GetESignListID method.
3.56 Returns DocVerify ID of Easy Sign Document
Get the DocVerify ID of a Easy Sign document based on the Unique ID of the document when created by calling the GetEasySignID method. If multiple documents were created with the same Unique ID only the latest one is returned.
3.57 Returns a list of the individual E-Sign document ID's that are in the packet.
Get a list of the DocVerify E-Signature documents by calling the GetPacketDocs method.
3.58 Returns the details or current audit trail of an E-Sign document.
Get the details of the DocVerify E-Signature document by calling the GetPacketDocs method.
3.59 Returns the data entered into the signature element form fields
The form field data can be retrieved by calling the GetSignatureFormData method.
3.60 Returns the the list of templates or documents in the library
The template list can be retrieved by calling the GetTemplateList method. This list is returned in either JSON or XML only.
3.61 Returns Current Version
The current version of the DocVerify API web services can be retrieved by calling the GetVersion method.
3.62 Validate the Integrity of a DocVerify Document
Validate the integrity of a DocVerify document by calling the ValidateDocument method.
4. Method Reference
4.2 Method Name: AddNewDocument
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.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: 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
4.5 Method Name: AddNewNotaryJournalEntry
Return Value: string. In case of successful submission - the value contains the JournalID in this case. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
4.6 Method Name: AddNewNotaryRequestDocument
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: AddProofNote
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.8 Method Name: CancelESign
4.8 Method Name: GetDocumentStatus
Return Value: string.
Return Values:
Not Found
Invalid Document - (Document could not be processed)
Processing
Completed - (Document is ready to be viewed or downloaded)
0 < Error - See Appendix A
4.9 Method Name: GetDocument
Return Value: base64binary. In case of a failure, no value is returned.
0 < Error - See Appendix A
4.10 Method Name: GetSignatureStatus
Return Value: string.
Return Values:
Not Found
Invalid Document - (Document could not be processed)
Not Complete - (Still out to be signed)
Cancelled - (Document owner has cancelled E-Sign request)
Completed - (Signature completed and is ready to be viewed or downloaded)
0 < Error - See Appendix A
4.13 Method Name: GetDocumentDetails
Return Value: DetailInfo (Integer. In case of a failure, a negative value is returned).
0 < Error - See Appendix A
4.13 Method Name: GetDocumentDetailsJSON
Return Value: String
0 < Error - See Appendix A
4.14 Method Name: GetENotaryList
Return Value: ENotaryInfo. In case of a failure, a negative value is returned.
If no records are found. Nothing is returned.
0 < Error - See Appendix A
4.15 Method Name: GetESignListID
4.15 Method Name: GetEasySignID
4.8 Method Name: GetPacketDocs
4.8 Method Name: GetSignatureDetailsJSON
Return Value: string.
Return Values:
Not Found
JSON - (Times are 24 hour based, and PST)
0 < Error - See Appendix A
4.16 Method Name: GetSignatureFormData
4.17 Method Name: GetTemplateList
Return Value: string.
0 < Error - See Appendix A
4.18 Method Name: GetSchedule
Return Value: string. The maintenance schedule is returned.
0 < Error - See Appendix A
4.19 Method Name: GetVersion
Return Value: string.The API version is returned.
0 < Error - See Appendix A
4.20 Method Name: ValidateDocument
Return Value: string.
If successful returns "pass".
If it fails returns "fail".
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.
PHP
When using PHP and the REST API's the file must be sent as a POST stream. If you're having issues this is a good place to start. http://stackoverflow.com/questions/3192496/restful-uploading-of-a-file-in-php
Appendix C - REST Troubleshooting
There are a few things to keep in mind when using RESTful methods.
- Make sure to always use POST
- When sending the files(s) , make sure they are streamed, the paramter name is correct, and not url encoded or converted to base64
- Make sure you POST using Multipart, and not the default encoded format