# Monitor integration health (https://docs.chargeflow.io/docs/platforms/monitor-integration-health)



Use the health check endpoints to verify that the Chargeflow API is reachable and that your API key is valid. These are lightweight endpoints designed for integration monitoring and pre-flight checks.

## Check service availability [#check-service-availability]

Verifies that the Chargeflow API is reachable and returning responses.

```
GET /public/2025-04-01/health-check
```

### Example request [#example-request]

```bash title="Terminal"
curl https://api.chargeflow.io/public/2025-04-01/health-check \
  -H "x-api-key: YOUR_PLATFORM_API_KEY"
```

### Example response [#example-response]

```json title="Response"
"OK"
```

A `200 OK` response confirms the service is available. Any non-200 response indicates a service-level issue. Check the [Chargeflow status page](https://status.chargeflow.io) for incident updates.

***

## Validate your API key [#validate-your-api-key]

Verifies that your `x-api-key` is valid and currently active.

```
GET /public/2025-04-01/health-check/access-key
```

### Example request [#example-request-1]

```bash title="Terminal"
curl https://api.chargeflow.io/public/2025-04-01/health-check/access-key \
  -H "x-api-key: YOUR_PLATFORM_API_KEY"
```

### Example response [#example-response-1]

```json title="Response"
"OK"
```

A `200 OK` confirms the key is valid. A `403` response with `{"message": "Forbidden"}` indicates an invalid or revoked key (see [Error handling](https://docs.chargeflow.io/docs/reference/api-fundamentals/error-handling)). Regenerate your credentials in the Developer Hub.

***

## When to use these endpoints [#when-to-use-these-endpoints]

<Callout title="Info">
  **Add health checks to your integration monitoring.** Call both endpoints in your uptime checks to
  catch connectivity issues before they affect your merchants.
</Callout>

Recommended use cases:

* **Startup/initialization check:** call before making other API calls when your service starts or redeploys, to confirm the integration is healthy.
* **Incident investigation:** if webhooks stop arriving or API calls fail unexpectedly, run these checks first to rule out connectivity and authentication issues before deeper debugging.
* **Canary monitoring:** include in synthetic monitoring to get alerted on Chargeflow availability issues without waiting for a real dispute to fail.

## Next steps [#next-steps]

<Cards>
  <Card title="integration.access.error" href="./webhook-events#integration-access-error">
    Get notified when a merchant connection breaks.
  </Card>

  <Card title="Error handling" href="/docs/reference/api-fundamentals/error-handling">
    Resolve the errors these checks surface.
  </Card>

  <Card title="Onboard a merchant" href="./eaas/onboard-a-merchant">
    Act on the merchant accounts behind a failed check.
  </Card>

  <Card title="Status" href="/docs/reference/status">
    Check for ongoing Chargeflow incidents.
  </Card>
</Cards>