Avalara Developer Network Developer communications

Chapter 1.2 - Authentication

Required Headers

These items must appear in your request header:

Key Value
api_key Base64 "username:password"
client_id Unique identifier for your company. Avalara provides this during account creation. Your Client ID is the same across all environments.
Content-Type application/json

Encode your API Key

The api_key is your Customer Portal "username:password" encoded in Base64. For example, if your username is first.last@avalara.com and your password is secretpassword!, your api_key is Zmlyc3QubGFzdEBhdmFsYXJhLmNvbTpzZWNyZXRwYXNzd29yZCE=. The Communications REST v2 Swagger page automatically generates your api_key for you. To generate the api_key on the Swagger page:
  1. Enter your username in the email address field.
  2. Enter your password in the password field.
  3. Click the Generate api_key button.
The encoded api_key is populated in the api_key field. Copy and save this value for later use.
You can also encode a plaintext string to Base64 in Windows Powershell using the following script:
# Encode a string to Base64
[System.Convert]::ToBase64String(
  [System.Text.Encoding]::UTF8.GetBytes("first.last@avalara.com:secretpassword!"));

Optional Headers

Our tax engine allows for additional customization when calculating taxes through Client Profiles. For details about how Client Profiles work, see Customizing Transactions. For now, just know that you can pass an additional header to use a specific profile:
Key Value
client_profile_id An integer that specifies which profile you want to use when calculating the taxes in this request

Note

If a client_profile_id is left blank, REST v2 uses the System Default configuration.