# Sovos API

**Canonical:** https://apis.io/apis/sovos/sovos-api/  
**Provider:** Sovos — https://apis.io/providers/sovos/  
**Base URL:** https://api-test.sovos.com  
**Documentation:** https://docs.sovos.com/en/e-invoicing/indirect-tax-api/api-authentication

Sovos API is one of 2 APIs that [Sovos](https://apis.io/providers/sovos/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Sovos API as documented publicly: 44 operations. Contract generated from the documentation by API Evangelist (2026-10-14); not the provider's own document.

## Operations (44)

| Method | Path | Summary |
|---|---|---|
| GET | `/documents/{countrycode}/{documentid}/notifications` | Get all notifications for a specific document |
| GET | `/notifications/{countrycode}` | Check for new notifications across all documents |
| PUT | `/notifications/{countrycode}` | Mark notifications as read |
| PUT | `/notifications/{countrycode}/bulk` | Acknowledge notifications in large batches |
| GET | `/notifications/{countrycode}/{notificationid}` | Retrieve a specific notification |
| POST | `/oauth/client_credential/accesstoken` | POST /oauth/client_credential/accesstoken |
| POST | `/oauth/token` | POST /oauth/token |
| POST | `/taxid-checks/{countrycode}` | Checks a tax ID against a national or regional database. |
| PUT | `/v2/configurations/erp-systems/{id}` | Configuration endpoints |
| POST | `/v2/configurations/networks/{networkid}/trading-partners/endpoints` | Configuration endpoints |
| DELETE | `/v2/configurations/networks/{networkid}/trading-partners/endpoints/{endpointid}` | Configuration endpoints |
| GET | `/v2/configurations/networks/{networkid}/trading-partners/endpoints/{endpointid}` | Configuration endpoints |
| PUT | `/v2/configurations/networks/{networkid}/trading-partners/endpoints/{endpointid}` | Configuration endpoints |
| GET | `/v2/configurations/organizations/{organizationid}` | Retrieves details from a given organization using its organizationId. |
| PUT | `/v2/configurations/organizations/{organizationid}` | Updates an organization. |
| GET | `/v2/configurations/organizations/{organizationid}/companies/branches` | Configuration endpoints |
| POST | `/v2/configurations/organizations/{organizationid}/companies/branches` | Configuration endpoints |
| PATCH | `/v2/configurations/organizations/{organizationid}/companies/{companyid}` | Updates a company from a given organization. |
| POST | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/async` | Submits an asynchronous company endpoint registration. Returns an asynchronous request identifier ( asyncRequestId ) that can be used to poll status. |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/async/removal/{requestid}` | Retrieves the status of an asynchronous request to delete all company endpoints, including per-endpoint progress and any errors. |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/async/{requestid}` | Retrieves the status of an asynchronous company endpoint registration request using the asyncRequestId returned by the submit operation. |
| DELETE | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/{endpointid}` | Deletes a given endpoint using its ID. |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/{endpointid}` | Retrieves details from a given endpoint using its ID. |
| PUT | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/endpoints/{endpointid}` | Updates details from a given endpoint using its ID. |
| GET | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/{id}` | Retrieves a list of branches configured in a given company. |
| PATCH | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/{id}` | Locks a company to block POST v1/documents requests for the associated taxId. |
| POST | `/v2/configurations/organizations/{organizationid}/companies/{companyid}/{id}` | Configuration endpoints |
| PATCH | `/v2/configurations/organizations/{organizationid}/companies/{taxid}/identity-validation` | Updates the identity-validation flag of a company identified by tax ID. Use true to mark the company as validated and false to revoke validation. This endpoi... |
| GET | `/v2/configurations/organizations/{organizationid}/erpSystem/{erpsystemid}/webhook` | Configuration endpoints |
| PUT | `/v2/configurations/organizations/{organizationid}/products` | Assigns available products to a given organization. |
| DELETE | `/v2/configurations/organizations/{organizationid}/products/{productid}` | Removes a product from a given organization. |
| GET | `/v2/configurations/organizations/{organizationid}/setting-contexts/{contextname}` | Configuration endpoints |
| GET | `/v2/configurations/organizations/{organizationid}/settings/{settingid}` | Configuration endpoints |
| PUT | `/v2/configurations/organizations/{organizationid}/settings/{settingid}` | Configuration endpoints |
| DELETE | `/v2/configurations/organizations/{organizationid}/users/{userid}` | Configuration endpoints |
| GET | `/v2/configurations/organizations/{organizationid}/{id}` | Lists all companies configured in a given organization. |
| POST | `/v2/configurations/organizations/{organizationid}/{id}` | Creates a group for a given organization. |
| GET | `/v2/configurations/report-setup/{categoryid}` | Retrieves the available report definition options for the given category. |
| POST | `/v2/configurations/report-setup/{categoryid}` | Configures which report definitions are active for the given category and scope. |
| GET | `/v2/configurations/workspaces/setting-contexts` | Configuration endpoints |
| GET | `/v2/configurations/workspaces/setting-contexts/{contextname}` | Configuration endpoints |
| POST | `/v2/configurations/workspaces/settings` | Configuration endpoints |
| GET | `/v2/configurations/{configurationid}` | Configuration endpoints |
| POST | `/v2/configurations/{configurationid}` | Configuration endpoints |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/openapi/_ae-authored/sovos-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/json-schema/sovos-get-notifications-countrycode-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/json-schema/sovos-get-documents-countrycode-documentid-notifications-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/json-schema/sovos-post-oauth-client-credential-accesstoken-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/json-schema/sovos-post-oauth-token-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/json-schema/sovos-get-notifications-countrycode-notificationid-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/sovos/refs/heads/main/json-schema/sovos-put-notifications-countrycode-response-schema.json

## Other Sovos APIs (1)

- [Sovos API](https://apis.io/apis/sovos/sovos-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sovos/sovos-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sovos/.