Auth Token

Overview

The TaxBit APIs use bearer tokens to authenticate requests.

Tenant Scoped Bearer Token: The tenant scoped bearer token is the primary authorization mechanism. It allows you to make requests to the following endpoints:

  • Account Owners
  • Transactions
  • Assets
  • Documents
  • Form Items
  • Gains
  • Inventory
  • Payers
  • Recon
  • Deprecated:
    • Users
    • Account Owners
    • Transactions
    • Inventory

Available Actions

  • Request a Tenant Scoped Bearer Token: Take this action to request a tenant scoped bearer token. Once you receive a tenant scoped bearer token, it is valid for 24 hours.

Prerequisites

Your TaxBit API credentials will be shared with you as part of the onboarding process. You can access your API credentials in the SendSafely account provided by your Implementation Manager.

Obtain your API credentials, including your client ID, client secret, and tenant id_, from your TaxBit Implementation Manager.

Token Security

The credentials provided will be:

  • client_id
  • client_secret
  • tenant_id

A bearer token is required for all subsequent API calls, so be sure to keep it secure. Don’t share your credentials and bearer tokens in publicly accessible areas. Use secure communication channels, such as HTTPS, when transmitting the token to and from the API.

Each token is only valid for 24 hours. After a token expires, it will be necessary to request a replacement token from this endpoint.

Refreshing the Token

The Bearer Token expires 24 hours after generation. When the token expires, retrieve a new token to continue accessing the API.