home

Indirect Tax

Sovos Docs

Show Page Sections

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

Register for sandbox access

Developers must register to access the Sovos developer portal, which is the sandbox environment for building and testing with Sovos APIs.
Note:

This sandbox does not give you access to products or gated documentation. For production access, register at developer-prod.sovos.com.

  1. Go to the registration page.
  2. Enter the required information, then click Continue.
    If you see a message after clicking Continue that you do not have access, you tried to sign up for an unsupported product using a direct or incompatible link. Try registering again. If the issue continues, reach out to your team's administrator for support.
  3. Go to your inbox, and click the verification email you received from Sovos.
  4. In the email, click Verify.
  5. Enter and confirm your password.

    The password must:

    • Be at least ten characters long

    • Include one uppercase letter, one lowercase letter, and one number

    • Include at least one special character: #@$!%*?&+~|{}:.-;<>/_

    • Not contain any spaces

  6. Optional: Set up two-factor authentication by following the prompts on the page.
You are logged into the developer portal.

Create API teams

API teams allow developers to collaborate on sandbox apps and share access to API credentials in a controlled way. You don't have to create a team to build apps in Sovos; however, teams provide a flexible way to manage shared access for testing and prototyping.

  1. Log in to the Sovos developer portal.
  2. Select the region for your team.
    The region switcher with the search bar is highlighted.
  3. Click API Teams in the menu, then click + Team.
  4. Enter a team name and a description, then enter the team members' email addresses separated by commas.
  5. Click Save.
    The success message API team created displays.

Add apps

Note:

Apps created in the developer portal are for sandbox use only. To register and manage production applications, contact your Sovos account manager.

Add an app to generate API keys and secrets needed to use the API in the sandbox environment.
  1. Log in to the Sovos developer portal.
  2. Select the app's region.
    The region switcher with the search bar is highlighted.
  3. Click Apps in the menu, then click + App.
  4. Enter a name and description for your app.
  5. In the APIs section, click Enable in the Actions column of the APIs you will be working with.
  6. Click Save.
    You will get a success message and will be redirected to the Apps page.
Copy the API key and the secret, which are needed to generate an access token using the API's authentication endpoint.