Fetch the health status of the Service Provider.

curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/health

{
  "components": [
    {
      "endpoints": [
        "endpoints",
        "endpoints"
      ],
      "name": "name",
      "description": "description",
      "id": "id",
      "type": "OTHER",
      "status": null
    },
    {
      "endpoints": [
        "endpoints",
        "endpoints"
      ],
      "name": "name",
      "description": "description",
      "id": "id",
      "type": "OTHER",
      "status": null
    }
  ],
  "description": "description",
  "time": "2000-01-23T04:56:07.000Z",
  "version": "version",
  "status": null
}

GET

health

curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/health

{
  "components": [
    {
      "endpoints": [
        "endpoints",
        "endpoints"
      ],
      "name": "name",
      "description": "description",
      "id": "id",
      "type": "OTHER",
      "status": null
    },
    {
      "endpoints": [
        "endpoints",
        "endpoints"
      ],
      "name": "name",
      "description": "description",
      "id": "id",
      "type": "OTHER",
      "status": null
    }
  ],
  "description": "description",
  "time": "2000-01-23T04:56:07.000Z",
  "version": "version",
  "status": null
}

Response

Service is healthy.

status

enum<string>

required

The status of a specific component reported by the Service Adapter.

Available options:

UP,

DOWN,

WARN

components

object[]

required

List of health status details for each component reported by the Service Adapter.

Show child attributes

components.id

string

required

The id of the component.

Maximum string length: 50

components.name

string

required

The name of the component.

Maximum string length: 150

components.type

enum<string>

required

The type of component affected when status is WARN or DOWN. The possible values are:

ADAPTER: The reported status is for the Service Adapter.
API: The reported status is for the Service Provider.
DATABASE: The reported status is for a database dependency of the Service Provider.
SYSTEM: The reported status is for any other known system component such as cache or gateway.
OTHER: The reported status is either for a component that does not belong to the types described above or the source of the issue is unknown.

Available options:

OTHER,

SYSTEM,

API,

ADAPTER,

DATABASE

components.status

enum<string>

required

The status of a specific component reported by the Service Adapter.

Available options:

UP,

DOWN,

WARN

components.description

string

The detailed status of the component.

Maximum string length: 250

components.endpoints

string[]

When the status of the component is not UP, then the list of endpoints affected.

time

string<date-time>

required

The timestamp of the health status reported by the Service Adapter.

version

string

Minimum string length: 1

description

string

The description of the health status returned by the Service Adapter.

Maximum string length: 250

Validate credentials Testing with Postman

⌘I

Partner SPI

Tax SPI

Tax Registration Number Validation SPI

Troubleshooting

Fetch the health status of the Service Provider.

Response