> For the complete documentation index, see [llms.txt](https://rivero.gitbook.io/amiko-documentation/JL6JD0mRhH1awRHP2Gz0/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rivero.gitbook.io/amiko-documentation/JL6JD0mRhH1awRHP2Gz0/development/issuer-integration-api/health-check.md).

# Health Check

To maintain reliability and ensure quality of service, every API, including those provided by the Issuer Bank, is equipped with a health status check. This allows for continuous monitoring and quick response to any service disruptions or issues.

## Health Check API Specification

This document outlines the specification used by Amiko for monitoring the health of services providing the API, based on the [IETF draft on Health Check Response Format for HTTP APIs](https://inadarei.github.io/rfc-healthcheck/).

Mandatory Field

The health check API response includes a single mandatory field and several optional fields to convey the health status of a service.

**Status** indicates the overall health of the service. It must be one of the following:

* `pass`: The service is healthy.
* `fail`: The service is unhealthy.
* `warn`: The service is healthy but with some concerns.

#### Status and HTTP Response Code

* For `pass` and `warn` statuses, the HTTP response code must be in the 2xx-3xx range.
* For `fail` status, the HTTP response code must be in the 4xx-5xx range.
* With a `warn` status, additional information should be provided in optional fields of the response.

### Optional Fields

The specification allows for additional, optional fields to provide more detailed health information, though these are not defined within this summary.

This design ensures that the health of the service can be efficiently monitored and understood through standard HTTP status codes and a simple, yet effective, payload structure.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://rivero.gitbook.io/amiko-documentation/JL6JD0mRhH1awRHP2Gz0/development/issuer-integration-api/health-check.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.