Skip to content

API Overview

API Overview

The ShipVAT API provides RESTful endpoints for tax rates and nexus thresholds.

Base URL

https://api.shipvat.com

Endpoints

EndpointMethodDescription
/healthGETHealth check (no auth)
/v1/ratesGETGet tax rates
/v1/thresholdsGETGet nexus thresholds
/v1/decision/collectPOSTTax collection decision
/v1/metadata/jurisdictionsGETList jurisdictions

Authentication

All /v1/* endpoints require a Bearer token:

Terminal window
-H "Authorization: Bearer sk_your_api_key"

Response Format

All responses are JSON:

{
"data": { ... },
"queried_at": "2024-01-15T10:30:00Z"
}

Error Format

{
"error_code": "ERROR_TYPE",
"message": "Human readable message",
"details": {}
}