WebHook or URL Push

DocVerify WebHook or URL Push Integration

The DocVerify webhook or URL push will allow you to automatically receive e-signature updates from DocVerify without having to pull the data from DocVerify. Once the data is received on your site, you can easily consume the data in order to instantly update your database or to display the data any way you like to your end users.

We can POST data to a URL on your server to notify you whenever the status of an e-signature document is updated or changes. You specify the URL we should do GET or POST to, if any, by clicking "My Account" and then clicking on the API tab.

Please note that DocVerify utilizes URL encoding, and it will be your responsibility to URL decode on your end. Also make sure that your page also responds with a status code 200, so that our system knows your systems received the data successfully. Also all POSTs are multipart forms.

This add-on may require special activation, and may have additional fees.

For more information visit www.docverify.com or contact DocVerify sales at sales@docverify.com.

NOTE: The data sent by DocVerify will be URL encoded, and you will have to decode it before saving the data in your systems.

Use with Easy Sign System Example:

Lets assume that you are using the Easy Sign system to instantly create a new e-signature document within an Iframe on your own site, the page you set up on your site is located at http://www.example.com/webhookconsumepage.aspx, and you also set it up to send the data from DocVerify to your site as a GET. The following will happen below.

  1. When the Iframe is called it will create a new document, and the following will be sent to your site. Notice how the status is "new".
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=new&datetime=01/01/2012%2013:00&signer=email@fakedomain.com
  2. After the Easy Sign system creates a new document, it will be display for the signer to sign, and the following will be sent to your site. Notice how the status is now "viewed".
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=viewed&datetime=01/01/2012%2013:00&signer=email@fakedomain.com
  3. When the signer signs the document, the following will be sent to your site. Notice how the status is now "signed".
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=signed&datetime=01/01/2012%2013:00&signer=email@fakedomain.com
    2. This step may be repeated based on the number of signers.
  4. After all the signers have signed the document, the following will be sent to your site. Notice how the status is now "completed".
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=completed&datetime=01/01/2012%2013:00

Webhook System Example:

Lets assume that you want your system to be updated as to the status of an e-signature document whenever an e-signature document status changes. The page you set up on your site is located at http://www.example.com/webhookconsumepage.aspx, and you also set it up to send the data from DocVerify to your site as a GET. The following will happen below. Please note that this example does not cover all the status codes, and it is just meant to give you an idea of the flow.

  1. Whenever an e-signature document is viewed, the following will be sent to your site.
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=viewed&datetime=01/01/2012%2013:00&signer=email@fakedomain.com
  2. When the signer signs the document, the following will be sent to your site.
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=signed&datetime=01/01/2012%2013:00&signer=email@fakedomain.com
    2. This step may be repeated based on the number of signers.
  3. After all the signers have signed the document, the following will be sent to your site.
    1. http://www.example.com/webhookconsumepage.aspx?docid=1234abcd-1234-1234-1234-abcd1234abcd&status=completed&datetime=01/01/2012%2013:00

Testing

If you haven't created a page where you can POST to in order to consume the data being sent to you via the webhook, we recommend using the testing site http://requestb.in to POST to to see the data being passed to you from DocVerify.

Troubleshooting

During a webhook POST or GET the system is looking for a status code of 200 to be returned from the system consuming the data. Make sure that your system return a 200 or else it will work properly. Additionally, if a purge is being requested make sure that the word "success" without the quotes is also returned; otherwise, the system isn't looking to consume any data from pages it is posting to other than the status code of 200.