Skip to main content
Avalara Help Center

Avalara CertCapture for eCommerce SDK (Software Development Kit)

This article applies to:Avalara CertCapture

Welcome to CertCapture for eCommerce! CertCapture's ecommerce module makes it possible to embed exemption certificate submission forms into your ecommerce site's user interface. The CertCapture ecommerce module can be implemented with or without an Application Programming Interface (API) connection.  

If you're inserting CertCapture's exemption certificate submission forms onto your ecommerce site without an API, submitted forms will be capable of pushing provided information to CertCapture. If you're inserting CertCapture's exemption certificate submission forms onto your ecommerce site with an API, you will have access to a Software Development Kit (SDK) with extended functionality that makes it possible to both push data to CertCapture from your site and call information from CertCapture to your site.
 

Before you begin

Technical requirements to embed forms within your site are straightforward; however, thorough planning prior to implementation will streamline the process once you've begun.  

You will need to gather the following information prior to implementation:

  • Your CertCapture Client ID, which can be found in your CertCapture account under Company Settings > Company Details >  Client Information.
  • Your CertCapture Registration Key, which can be found in your CertCapture account under Company Settings > Company Details > Webportal Registration.

If you have an issue accessing either, please reach out to your Customer Account Manager (CAM).

Here are some things worth considering before you begin:

  • The individual(s) responsible for embedding forms on your site will need to have JavaScript, JQuery, CSS or other styling language, and possibly API experience (if you will be making calls from CertCapture as a part of your implementation). You will need to budget time for initial installation and testing. Prolonged testing and ongoing modifications may be necessary if optimized customer experience are a focus of your team.
  • Where will you embed access to exemption certificate submission forms on your site? It's common to enable exemption certificate entry within your customers' Account Settings areas and/or as a part of your site's Checkout Process. You can, of course, embed forms wherever you would like within your site; plan ahead for where it make the most sense to install within your site's interface.
  • Once you've successfully installed (an) exemption certificate submission form(s) on your site, your customers can upload their exemption certificates to your CertCapture account through the form(s) you've created. As a part of your initial install, you will need to determine what you want to happen to certificates within CertCapture once they've been submitted. You will select one of these two options - Submit to Stack or Auto-Validate - when configuring the JavaScript needed to generate certificate submission forms on your site. Your decision here will impact user experience, so is important to consider which is best for your site:
    • Submit to Stack - places submitted certificates into a queue for manual validation (approval) within your CertCapture account. This is the more conservative of the two options, as it provides for the opportunity to vet submitted exemption certificate documents before exempting customers' purchases. This option creates an inherent delay between exemption certificate submission and ability to complete an exempt transaction on your site, so may be less optimal from the customer experience perspective.
    • Auto-Validate - automatically completes the exemption certificate validation (approval) process within your CertCapture account, making it possible for your customers to complete exempt transactions on your site immediately following exemption certificate submission. While more convenient, this option creates the possibility for incomplete or incorrect forms to be submitted and applied to transactions, which may create the need for post-sale follow-up by a member of your team.

You're ready for install

Once you have gathered all required information and have considered the items outlined above, you are ready to incorporate CertCapture exemption certificate submission forms into your ecommerce site's user interface. You will find complete instructions, example code, variables with definitions, and implementation scenarios here.

Note:

For questions related to installation or implementation, please reach out to Avalara Support by email or by phone.