DocVerify Transactions API Reference

The DocVerify Transaction system is part of DocVerify's Fraud Prevention System designed to reduce the occurrences of friendly fraud.

For more information visit www.docverify.com

Sections

• Overview
• Requirements
• Templates
• Programmers Guide
• Method Reference
  • AddNewTransaction
  • AddNewTransactionThirdParty
  • AddNewVoiceSignatureTransaction
  • AddNewVoiceSignatureTransactionThirdParty
  • ChargebackFiled
  • ChargebackReversedByIssuer
  • GetVoiceSignatureStatus
  • GetTemplatesList
  • RetryVoiceSignature
  • 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 Transactions API facilities for creating new electronically signed documents based upon transactions. The DocVerify Transaction API Web Services is available with the proper DocVerify edition account. Credits will be required to add new transactions.
  • The service only supports secure communication 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.
  • Please go to the Transaction Templates documentation page to learn about how to properly use the DocVerify dynamic template system.
    • IMPORTANT: YOU MUST CLEARLY INCLUDE ON YOUR PAGE THE SIGNER'S CONSENT AND UNDERSTANDING THEY'RE ELECTRONICALLY SIGNING, AND IF UTILIZING THE VERIVOICE SYSTEM THAT THEIR VOICE WILL ALSO BE RECORDED.
    • 2. Requirements
  • Access to the Internet over port 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
    • PHP
    • SOAP toolkits
    • etc.
  • Some of the API methods are also available as REST based API's. REST methods are indicated in section 4.
  • IMPORTANT: At the time any of the Transaction Add Methods are invoked, it is DocVerify policy and a requirement that somewhere in your flow there is a textbox that is clearly marked as signature where the user can enter their electronic signature; otherwise, your access to the transaction system may be revoked as a result.
    • 3. Templates
  • In order to use the DocVerify Transaction System, you will have to create templates, agreements, contracts that will be used to create documents on the fly after you pass the data to DocVerify. Templates are created by going to www.docverify.com, signing in, go to Contract Mgmt and click on "Transaction System". Once the page loads, you can create a new template or update an existing template, and a Template ID will be generated for you to use. The page also contains complete instructions as well. For a reference about the template system please refer to the Transaction Templates Documentation. The template system is also capable of handling structered XML data, and for reference please refer to the DocVerify XML System Documentation.
    • 4. Programmers Guide
  • 4.1 Accessing the DocVerify API Web Service
    • 4.1.1 The DocVerify Transactions API Web Service WSDL may be accessed at https://api.docverify.com/transactions/?wsdl.
  • 4.1.2 The DocVerify Transactions API Web Service may be accessed at https://api.docverify.com/transactions/.
  • 4.2 Parameters
    • 4.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.
  • 4.3 Add a New Transaction
    • Use this method if you are generating a transaction for your own service using the AddNewTransaction method.
    • This method is also available as a REST API. REST address https://api.docverify.com/rest/transactions/newsignaturetransaction
  • Note: A transaction credit may be required.
  • 4.4 Add a New Transaction from a Third Party
    • Use this method if you are generating a transaction on the behalf of another entity. For example, a payment provider would use this method to create transactions for their merchant, thereby making the merchant the owner of the document by using the AddNewTransactionThirdParty method.
  • Note: A transaction credit may be required, and this feature must be enabled. In order to utilize this feature please contact your reseller or your DocVerify account executive.
  • 4.5 Add a New Voice Signature Transaction
    • Use this method if you are generating a transaction for your own service where DocVerify will call that person to obtain the vocal recording by using the AddNewVoiceSignatureTransaction method.
    • This method is also available as a REST API. REST address https://api.docverify.com/rest/transactions/newvoicesignaturetransaction
  • Recording Note: If the signer makes a recording less than 1.0 seconds, the call recording will be incomplete and the signer must be called again.
  • Note: Voice Credits are required for this feature and a transaction credit may also be required.
  • 4.6 Add a New Voice Signature Transaction from a Third Party
    • Use this method if you are generating a voice signature transaction on the behalf of another entity. For example, a payment provider would use this method to create transactions for their merchant, thereby making the merchant the owner of the document by using the AddNewVoiceSignatureTransactionThirdParty method.
  • Recording Note: If the signer makes a recording less than 1.0 seconds, the call recording will be incomplete and the signer must be called again.
  • Note: Voice Credits may be required for this feature in addition to a transaction credit, and this feature must be enabled. In order to utilize this feature please contact your reseller or your DocVerify account executive.
  • 4.7 Update an existing Transaction document if a Chargeback has been filed
    • Update an existing transaction document if a chargeback has been filed by using the ChargebackFiled method. You must be the owner of the document.
  • 4.8 Update an existing Transaction document if the chargeback was reversed
    • Update an existing transaction document if a chargeback has been reversed by the issuer or you won the dispute by using the ChargebackReversedByIssuer method. You must be the owner of the document.
  • 4.9 Gets the current status of a Voice Signature Transaction
    • Get the status of the voice signature transaction document by using the GetVoiceSignatureStatus method. If this method is invoked before the AddNewVoiceSignature methods have been initialized it may return an "invalid" error. It is recommended to invoke this method 15 to 20 seconds after creating a new document; however, after the addvoicesignature methods have been initialized this method can be called at any interval from one second to 60 seconds and as many times as desired.
    • Note: This feature may have to be enabled, and additional fees may apply for this feature. Please contact your reseller or your DocVerify account executive.
  • 4.10 Get a current list of Transaction Templates
    • Get your current transaction template list by using the GetTemplatesList method.
    • This method is also available as a REST API. REST address https://api.docverify.com/rest/transactions/gettemplatelist
  • 4.11 Retries the voice signature again if the first attempt failed.
    • Retry the failed voice signature again by calling the signer again, and you will also be able to change the number if needed by using the RetryVoiceSignature method.
    • 5. Method Reference
  • All properties or variables are required unless they are specifically stated as being optional.
    • 5.1 Method Name: AddNewTransaction

• 5.2 Method Name: AddNewTransactionThirdParty

• 5.3 Method Name: AddNewVoiceSignatureTransaction

• 5.4 Method Name: AddNewVoiceSignatureTransactionThirdParty

• 5.5 Method Name: ChargebackFiled

• 5.6 Method Name: ChargebackReversedByIssuer

• 5.7 Method Name: GetVoiceSignatureStatus

• 5.8 Method Name: GetTemplatesList

• 5.9 Method Name: RetryVoiceSignature

• Appendix A - Return Codes
• Results of DocVerify API Web Service