> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perkstar.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# API status

> Check live Perkstar API, dashboard, scanner, wallet, webhook, billing, and POS service health.

Use the [Perkstar status page](https://dashboard.perkstar.co.uk/status) before
investigating an integration failure. It combines direct dependency checks with
the production synthetic journey that runs across Perkstar services.

<Card title="Open live status" icon="signal" href="https://dashboard.perkstar.co.uk/status">
  View current component health, the latest automated check, 24-hour check
  success, and recent affected components.
</Card>

## Components

| Component | What is checked |
| - | - |
| Public API | Database readiness, cache access, and API health |
| Dashboard | Business sign-in and application availability |
| Scanner | Staff sign-in, scanner loading, and version delivery |
| Wallet services | Apple Wallet pass delivery boundaries |
| Webhooks and billing | Webhook ingestion and Stripe connectivity |
| POS integrations | Scheduled POS synchronization smoke mode |

The page deliberately does not stay silently green when monitoring is late. If
the synthetic run has not completed within its expected window, components show
as degraded until a fresh result arrives.

## Machine-readable status

```bash theme={null}
curl https://dashboard.perkstar.co.uk/api/status
```

The JSON endpoint allows cross-origin GET requests and returns the overall
condition, component conditions, 24-hour success percentages, timestamps, and
recent affected component names. It never exposes internal exception messages
or tenant data.

<Note>
  Include the `X-Request-Id` from a failed API response when contacting support.
  The status page identifies broad service health; the request ID lets Perkstar
  trace one integration call.
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.