Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "_links": {
    "kyc": {
      "description": "Submit KYC information",
      "href": "/v0/user/me/kyc",
      "method": "PUT"
    },
    "self": {
      "href": "/v0/user/me",
      "method": "GET"
    },
    "wallets": {
      "href": "/v0/wallets",
      "method": "GET"
    }
  }
}

Headers

x-ping-key
string | null

Response

All services healthy

HAL-style hypermedia links for navigation and available actions.

status
enum<string>
required
Available options:
healthy,
degraded,
unhealthy
service
string
required
version
string
required
environment
string
required
timestamp
integer
required
services
ServicesStatus · object
required
settings
SettingsInfo · object
required