Avalara Developer Network Developer certcapture

Prompting users for certificate information with the AvaTax Certs API

The AvaTax Certs product is a stand-alone exemption certificate management product that can be used in conjunction with the AvaTax Calc product. The Certs product allows a company to track exempt customers, initiate automated correspondence to request certificate information from those customers, and track and manage the resulting exemption certificates. All valid certificates created/recorded in the AvaTax Certs product sync over to the AvaTax Calc product as well - once a customer has a valid exemption certificate in Certs, they will automatically be tax exempt for your tax calculations.

There is a RESTful API to interact with the AvaTax Certs objects. That API documentation is password-protected. If you have an AvaTax Certs portal account, that same credential set will grant you access to the API documentation.

Note that the AvaTax Certs product is currently being combined with the CertCapture product, but this article uses the resource terminology specific to the AvaTax Certs API.

If you are interested in flagging your customers as tax exempt within the AvaTax Calc product (and not in using an additional certificate management product), take a look at this summary of managing exempt customers.

Okay, now let’s get down to brass tacks. You have a customer who is buying things on your website and wants to let you know that they are tax exempt. Here’s a diagram of the recommended workflow (with API calls):

AvaTax Certs Workflow

*If you’re using the AvaTax Calc product to calculate tax, it will reflect the existing exempt status for the customer.

** The wizard URL is just www.vcert.com/<certificate-request-id>, where the certificate request ID is the unique request identifier returned in the Org-Requests POST response. Note that if a customer already has an open certificate request, Org-Requests POST will return an error, and that existing request ID can be retrieved with Org-Requests GET.

This workflow will cover the following starting cases:

  • The customer record does not yet exist.
  • The customer record exists, but has no certificates and no open certificate request.
  • The customer record exists and has an open certificate request.
  • The customer record exists and has one or more expired/revoked certificates and no open certificate request.
  • The customer record exists and has one or more valid certificates.

Once a customer has filled out their exemption information, their order can be processed per your business use case.

Subscribe via RSS!

Back to posts