Skip to navigation
AvaTaxPublic reference

Ping

View as Markdown

Access control: this endpoint is available to users with the everyone role.

Check connectivity to AvaTax and return information about the AvaTax API server.

This API is intended to help you verify that your connection is working. This API will always succeed and will never return a error. It provides basic information about the server you connect to:

  • version - The version number of the AvaTax API server that responded to your request. The AvaTax API version number is updated once per month during Avalara’s update process.
  • authenticated - A boolean flag indicating whether or not you sent valid credentials with your API request.
  • authenticationType - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication.
  • authenticatedUserName - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.
  • authenticatedUserId - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user.
  • authenticatedAccountId - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user.

This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even if you do not have verified connection credentials. If this API fails, either your computer is not connected to the internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available. For more information on the uptime of AvaTax, please see Avalara’s AvaTax Status Page.

Security Policies

  • This API may be called without providing authentication credentials.

Authentication

Authorizationstring
API Key authentication via header

Headers

X-Avalara-ClientstringOptionalDefaults to Swagger UI; 26.7.0; Custom; 1.0

Identifies the software you are using to call this API. For more information on the client header, see Client Headers .

Response

Success
versionstringOptional
Version number
authenticatedbooleanOptional

Returns true if you provided authentication for this API call; false if you did not.

authenticationTypeenumOptional
Returns the type of authentication you provided, if authenticated
Allowed values:
authenticatedUserNamestringOptional
The username of the currently authenticated user, if any.
authenticatedUserIdintegerOptional
The ID number of the currently authenticated user, if any.
authenticatedAccountIdintegerOptional
The ID number of the currently authenticated user's account, if any.
authenticatedCompanyIdintegerOptional
The ID number of the currently authenticated user's company, if any.
crmidstringOptional
The connected Salesforce account.

Errors

400
Bad Request Error
401
Unauthorized Error