Skip to navigation
AvaTax for ExcisePublic reference

Tests connectivity and the version of the service.

View as Markdown

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

Check connectivity to the Excise Platform API and return information about the API server.

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

  • version - The version number of the Excise Platform API server that responded to your request.
  • authenticated - A boolean flag indicating whether or not you sent valid credentials with your API request.
  • authenticatedUserName - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.

Authentication

Authorizationstring
API Key authentication via header

Headers

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

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

Response

Returns service version information and authentication status.
versionstringOptional
Gets or sets the version of the service that responded to the ping request. This property indicates which version of the service API is currently active.
authenticatedbooleanOptional
Gets or sets a boolean value indicating whether the current user is authenticated. True if the user has valid authentication credentials, false otherwise.
authenticatedUserNamestringOptional

Gets or sets the username of the authenticated user. This property contains the username of the currently authenticated user, or null/empty if the user is not authenticated.