Skip to main content

Status

The Status API provides a public endpoint to check the operational status of Basis Theory services across different regions. This endpoint does not require authentication and can be used for health checks, monitoring, and integration with status pages.

Get Status​

Returns the operational status of Basis Theory services. By default, returns status for all regions.

GET
https://api.basistheory.com/status
Copy

Authentication​

This endpoint is publicly accessible and does not require authentication.

Request​

# Check all regions
curl "https://api.basistheory.com/status"

# Check US region only
curl "https://api.basistheory.com/status?region=us"

# Check EU region only
curl "https://api.basistheory.com/status?region=eu"

Query Parameters​

ParameterRequiredTypeDescription
regionNostringFilter status by region. Valid values: us, eu. If omitted, returns status for all regions.

Response​

Returns a Status Object if successful.

{
"us": {
"tokens": true
},
"eu": {
"tokens": true
}
}

When filtering by a specific region, only that region's status is returned:

{
"us": {
"tokens": true
}
}

Status Codes​

CodeDescription
200Success - status retrieved successfully
400Invalid region specified
503Service unavailable

Error Responses​

When an invalid region is specified:

{
"error": "Invalid region: invalid. Valid regions are: us, eu"
}

When the service is unavailable:

{
"error": "Service unavailable"
}

Status Object​

AttributeTypeDescription
usobjectStatus of services in the US region
us.tokensbooleanOperational status of the token service in the US region. true = operational, false = unavailable
euobjectStatus of services in the EU region
eu.tokensbooleanOperational status of the token service in the EU region. true = operational, false = unavailable

Monitored Services​

ServiceDescription
tokensThe tokenization service for creating and managing tokens