API Reference
- Partner SPI
- Tax SPI
- Overview
- Authorization
- Address
- TaxEstimate
- Invoice
- CreditNote
- Authentication
- Health
- Testing with Postman
- Tax Registration Number Validation SPI
- Troubleshooting
Health
Fetch the health status of the Service Provider.
This endpoint is used to fetch the health status of the Service Provider.
GET
/
health
curl --request GET \
--url https://rest.taxes.provider.com/api/v1/health
{
"status": "UP",
"version": "1.0.0",
"description": "The service is healthy.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "UP"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "UP"
}
],
"time": "2022-11-01T05:12:08.131Z"
}
Response
200
application/json
Service is healthy.
The response is of type object
.
curl --request GET \
--url https://rest.taxes.provider.com/api/v1/health
{
"status": "UP",
"version": "1.0.0",
"description": "The service is healthy.",
"components": [
{
"id": "app-db-memory",
"name": "Application Database",
"type": "DATABASE",
"status": "UP"
},
{
"id": "adapter-server",
"name": "Adapter API Server",
"type": "ADAPTER",
"status": "UP"
},
{
"id": "service-server",
"name": "API Server",
"type": "API",
"status": "UP"
}
],
"time": "2022-11-01T05:12:08.131Z"
}
Assistant
Responses are generated using AI and may contain mistakes.