Ping

Before making any API endpoint requests, you can check the connectivity and response time of our server using the Ping endpoint.

This allows you to verify whether the JWT is valid or not and also helps you identify any connectivity issues between your software and our API server before requesting endpoints.

GET Utility/Ping 

Response Body

Field	Type	Description
StatusCode	number	Returns the status codes like 200,300 etc
StatusName	string	Name of the status code
StatusMessage	string	Detailed status message
APIVersion	string	TaxBandits API version
JWTExpiry	string	Your current JWT Expiry time
TimeZone	string	TaxBandits API server time zone
Errors	object[]	Shows error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error

Response JSON

Success Response - This is a sample response for successful API requests.

{
   "StatusCode": 200,
   "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "APIVersion": "V1.7.3",
    "JWTExpiry": "1696917733",
    "TimeZone": "UTC",
    "Errors": null
}