home

Indirect Tax

Sovos Docs

Show Page Sections

Connect to the Sovos Developer Hub

The Sovos Developer Hub 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 Hub (sandbox or production)

  • Create an app in the Developer Hub 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 , make sure to include the country code (+##).

  3. To read the Sovos terms, click the terms link. Then, select I agree to the terms.
  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 API team

Traditionally, each individual user has their own API credentials, restricting access and management. However, this approach complicates collaboration among development teams and increases business risks. As an alternative, you can create an API team, which is a computer user that allows multiple people to access and manage the same API credentials.

With API teams, Sovos apps are registered directly to the team, rather than to a specific user. This setup enables seamless collaboration by allowing multiple team members from the same team to view and manage the same set of API credentials.

  1. Log in to the Developer Hub (production or sandbox).
  2. Click your email address and select Teams.
  3. Click NEW TEAM.
  4. In the Overview section, enter your Team name (required) and Description.
  5. In the Members section, click Add another member.
  6. Enter the member's email address and select their Role.
    Note:

    If the user invited to the team does not already have a Developer Hub account, they will receive an email invitation with a link to create a new account. After registering, they will be able to see the API team and app and, depending on their role, they'll also be able to manage the API credentials from that app.

  7. After adding one or more members, click CREATE.
Now, as the team owner, you should create an app and choose the team in the Owner field. Also, note that it's not possible to edit an existing app to change the owner.

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.