# API Health Check

The API "Health check" is used to determine, whether the Saferpay environments are generally available. This function is available for test and production respectively and involves a simple **GET** call to the following URL:

* **Live:** `https://www.saferpay.com/api/health/[YOUR CUSTOMERID]`
* **Test:** `https://test.saferpay.com/api/health/[YOUR CUSTOMERID]`

When using the Health check API, you agree to the following rules:

* Do not poll the API status without any limitation (see below).
* Restrict yourself to 1 request every 5 minutes.
* Do not check the API status before every transaction.

In case of violation, Saferpay reserves the right to limit access to this API.

The API responds in two ways:

## Success

The success case returns `200 (OK)`.

```json
{
  "Status": "PASS"
}
```

## Failure

The failure case depends on what is happening, but in case of an unavailability of the Saferpay Service, the response-code would simply be anything else than `200(OK)`.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/api-health-check.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.