Notary Partners
DocVerify Notary Partner Web Services
This API is not publicly open, and requires special permissions and additional agreements to access. For more information visit www.docverify.com
Sections
Overview
Requirements
Programmers Guide
Method Reference
AddFileIntegrity
AddNewNotaryJournalEntry
CheckIfUserNotaryCommission
CheckIfUserNotaryEmail
GetNotaryList
GetRemoteNotaryRequestInfo
GetUserNotaryInfo
NewNotaryApplication
DownloadForERecord
AddNewNotaryTransaction
ChangeNotary
UpdateEJournalTransaction
GetUserNotaryInfoJSON
AddNewNotaryPacketMismo
GetNotaryID
GetErrorCodeDescription
Appendix A - Error Codes
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. Credits will be required to add new transactions.
The service only supports secure between the custom-programmed application and the DocVerify servers.
IMPORTANT: This API and its methods are only available to DocVerify e-Notary partners, and are NOT available to anyone else. If you want to access them please contact DocVerify as they do require contracts and agreements beyond the scope of the subscription services.
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/notary/?wsdl.
3.1.2 The DocVerify API Web Service may be accessed at https://api.docverify.com/notary/.
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 for File Integrity Protection
Send a document to add file integrity to by using the AddFileIntegrity method.
Note: All documents must be PDF's
3.42 Add a New Journal Entry For Specific Notary
Add a new journal entry by using the AddNewNotaryJournalEntry method.
3.43 Check If User Is A Notary In DocVerify
Check or validate if the notary is activated in DocVerify with their commission and state by using the CheckIfUserNotaryCommission method.
Note: Only notaries that have selected to be public are shown or notaries that are child accounts of either the APIKey initiating the request or specified parent account. Additionally, some states do not issue their notaries commission numbers, and if that is the case it will make using this method difficult.
3.44 Check If User Is A Notary In DocVerify With Email
Check to see if the user is a notary in DocVerify with their email by using the CheckIfUserNotaryEmail method.
3.45 Get A List of Notaries
Gets a list of notaries by state by using the GetNotaryList method.
Note: Only notaries that have selected to be public are shown or notaries that are child accounts of either the APIKey initiating the request or specified parent account
3.46 Get Signer Remote Notary Info
Gets the unique info for the signers when it is a remote notary by using the GetRemoteNotaryRequestInfo method.
Important: This may provide the Signer URL, and it is ONLY permitted to provide the link in an email. It is prohibited to use the Signer URL in an Iframe as that will adversely not only affect the functionality, but will also violate many privacy guidelines.
3.47 Get User Notary Info
Gets the users DocVerify info if they are a notary or e-notary by using the GetUserNotaryInfo method.
3.48 Submit a new notary Application
Submit a new notary application by using the NewNotaryApplication method.
Note: This method is completely locked, and only accessible on a case by case basis. Also, if the notary doesn't have a DocVerify one will be created for them.
3.49 Download document for purposes of e-Recording
Download a document for e-recording by using the DownloadForERecord method.
Note: This method is removes all of the DocVerify security features from the document, and we highly do not recommend using this method to download unless the document will be e-Recorded as its origin cannot be proven.
3.50 Add a New E-Notary or Remote Notary Transaction
Add a new notary transaction that's for a specific notary to complete the notarial act by using the AddNewNotaryTransaction method.
3.51 Change to placeholder notary to a permanent notary
Change the placeholder notary to a new permanent notary for the transaction by using the ChangeNotary method.
Note: This can only be changed once and once only if the notary being changed is a placeholder notary
3.52 Update an e-Journal entry for an E-Notary or Remote Notary Transaction
Update an e-journal entry for an e-notary transaction by using the UpdateEJournalTransaction method.
3.53 Get User Notary Info in JSON
Gets the users DocVerify info if they are a notary or e-notary by using the GetUserNotaryInfoJSON method.
Note: Although it may return a valid notary for the searched username, it is possible the notary belongs to another parent account, which will result in a rejection if anyone other than that parent's account requests that notary.
3.54 Add a new notary packet using the MISMO XML
Add a new notary packet transaction using the MISMO XML file by using the AddNewNotaryPacketMismo method.
3.55 Get the error code descriptions
Get a full description for an error code by using the GetErrorCodeDescription method.
4. Method Reference
4.2 Method Name: AddFileIntegrity
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: AddNewNotaryJournalEntry
Return Value: string. In case of successful submission - the value will be a DocVerify ID. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
4.4 Method Name: CheckIfUserNotaryCommission
Return Value: JSON string. The string below is returned if success or fail.
Success:
[{"IsNotary":true,"IsENotary":true,"CommissionExpires":"5/1/2025","NotaryID":"4564GtsfdfddGFF4546h+BxfcsJNAdt1twlua","FirstName":"Ian","LastName":"Notary","Address":"1234 Main Street","City":"Raleigh","State":"NC","Zip":"12345","IssueState":"DS","County":"mycounty","Municipality":"muni"}]
Failure:
{""error"": ""-100""}
0 < Error - See Appendix A
4.5 Method Name: CheckIfUserNotaryEmail
Return Value: string. In case of successful submission - the value will be returned as the NotaryStatus object. In case of a failure or no results, a negative value is returned or nothing is returned.
0 < Error - See Appendix A
4.6 Method Name: GetNotaryList
Return Value: string. In case of successful submission - the value will be returned in JSON. In case of a failure, a negative value is returned.
Note: The date time returned is Epoch time, and if the commission is expired IsENotary will always be false.
Sample Success:
[{"IsNotary":true,"IsENotary":false,"CommissionExpires":"\/Date(1352012340000)\/","NotaryID":"1234567890","FirstName":"Michael","LastName":"Smith","Address":"123 Main","City":"Dallas","State":"TX","Zip":"12345","IssueState":"TX","Email":"email@domain.com","Error":0},{"IsNotary":true,"IsENotary":true,"CommissionExpires":"\/Date(1383638340000)\/","NotaryID":"9876543210","FirstName":"Jane","LastName":"Doe","Address":"456 Main","City":"Irving","State":"TX","Zip":"12345","IssueState":"NC","Email":"email@domain.com","Error":0}]
0 < Error - See Appendix A
4.7 Method Name: GetRemoteNotaryRequestInfo
Return Value: RemoteNotary collection. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
4.8 Method Name: GetUserNotaryInfo
Return Value: NotaryStatus. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
4.9 Method Name: NewNotaryApplication
Return Value: string. If successful a value of zero or greater is returned. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
5.0 Method Name: DownloadForERecord
Return Value: Byte Array. If successful the document will be sent for download. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
5.0 Method Name: AddNewNotaryTransaction
Return Value: string. In case of successful submission - the value will be a DocVerify ID. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
5.1 Method Name: ChangeNotary
Return Value: string. In case of successful submission - the value will be 0. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
5.2 Method Name: UpdateEJournalTransaction
Return Value: string. In case of successful submission - the value will be 0. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
5.3 Method Name: GetUserNotaryInfoJSON
Return Value: string. In case of successful submission - the value will be JSON string. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
Example returned JSON:
{"IsNotary":true,"IsENotary":true,"RemoteCapable":true,"CommissionExpires":"05/01/2020","NotaryID":"u/l1m/KPRitD+Qld+VZXq+BxfcsJNAdt1twlua7/X5Eal/uzvObbYQ==","FirstName":"DEMO","LastName":"NOTARY","Address":"1234 main street","City":"Raleigh","State":"NC","Zip":"27603","IssueState":"TX","County":"Johnston","Municipality":"muni ttp","Success":true,"PaidEdition":true,"SubscriptionExpires":"01/04/2020","Error":0}
5.4 Method Name: AddNewNotaryPacketMismo
Return Value: string. In case of successful submission - the value will be a DocVerify ID. In case of a failure, a negative value is returned.
0 < Error - See Appendix A
Sample Required MISMO XML Below
MISMO XML Notary Sample.xml5.5 Method Name: GetErrorCodeDescription
Return Value: string. In case of successful submission - the description will be returned.
0 < Error - See Appendix A