home

Indirect Tax

Sovos Docs

Show Page Sections

Connect to Sovos

Connect to the Sovos developer sandbox

The Sovos developer portal provides access to app registration and authentication services, making sure businesses remain compliant with global tax regulations through the Indirect Tax API.

The Indirect Tax API simplifies tax compliance processes and allows companies to connect to Sovos tax compliance solutions through a single integration. This allows businesses to integrate only once with the Sovos platform and gain access to a range of compliance services.

The API lets businesses remain compliant by delivering real-time updates and adjustments. Sovos monitors tax regulations across the globe, making sure the API is always updated with the latest requirements.

To start using Indirect Tax API, you must:
  • Create a account in the developer portal (sandbox or production)

  • Create an app in the developer portal that lets you generate an API key and a secret

  • Copy the authentication keys (API key and secret) from your app

  • Generate an authentication token to use most API endpoints

Create a developer account

To integrate with the Sovos API for the first time, you need to create an account in the sandbox Developer Hub. You should create an account in the production Developer Hub only after completing the testing phase.
  1. Go to the sandbox or to the production account creation page.
  2. Fill out the form with the requested data.
    Tip:

    When entering the phone number, make sure to include the country code (+##).

  3. To read the Sovos terms, click the Developer Terms and Conditions link. Then, select the checkbox to agree.
  4. Click Create Account.
  5. (Production-only) Contact your Sovos representative assisting in the integration to approve the registration.
  6. Check your inbox and spam folder for an email with the subject "Verify your new account".
    Important: If it takes longer than ten minutes to validate the account, you will need to get a new validation link.
  7. Click the link provided in the email.
After verifying your account, log in to the Developer Hub using the email and password.

Create an app in the Developer Hub

Create an app to generate the authentication keys (API key and Secret) needed to use the API in either the sandbox or production environments.
  1. Log in to the sandbox or to the production Developer Hub.
  2. Click your email address and select Apps.
  3. Click +NEW APP.
  4. Enter the data or select the required fields in these sections:
    Overview
    Enter a Name (required) and a Description for the app.
    Owner
    By default, it is your user account. If you have a team, select it here.
  5. In the APIs section, depending on the Developer Hub environment, you need to:
    • (Sandbox) Click Enable to add each API or API resource to your app.
    • (Production) Click Request for Sovos to request access to each API or API resource.
  6. Click Save.
    Note: Expect a slight delay when registering a new app for production because Sovos must approve the request. New sandbox apps are automatically approved and immediately available for use.
In the API Keys section, click the copy buttons to copy the API Key and the Secret, which are needed to generate an access token using the API's authentication endpoint.

Copy the authentication keys

After creating an app, you must copy the authentication keys, which are needed for generating the OAuth token in most endpoints.
  1. Log in to the sandbox or to the production Developer Hub.
  2. Click your email address and select Apps.
    Warning: Do not select Teams.
  3. Under API Keys, click the copy icon to get the Key and the Secret values.
After you configure the app and obtain the API Key and Secret, you must share the email address used to create the app with the Sovos Professional Services team. After that, they will configure the email used to create the app in Compliance Network.