# Health Check

Health check endpoint for the API

Endpoint: GET /health
Version: v1
Security: oauth2ClientCredentials

## Header parameters:

  - `x-correlation-id` (string)
    A unique transaction id used to correlate api requests end to end.

  - `x-source-system` (string)
    A unique identification string for the source system.

## Response 200 fields (application/json):

  - `applicationName` (string, required)
    Application Name
    Example: "SERV Verify EAPI"

  - `applicationVersion` (string, required)
    Application Version
    Example: "1.0.0"

  - `apiName` (string, required)
    API Name
    Example: "serv-verify-eapi"

  - `environment` (string, required)
    Environment
    Example: "PROD"

  - `status` (string, required)
    Status
    Example: "running"

## Response 500 fields (application/json):

  - `code` (string, required)
    The HTTP Status code of the response.
    Example: "400"

  - `errorType` (string, required)
    Error Type
    Example: "ESB:BAD_REQUEST"

  - `description` (string, required)
    Error Description
    Example: "Bad Request"

  - `timestamp` (string, required)
    The time at which the API was invoked
    Example: "2022-01-17T03:31:09.691Z"

  - `correlationId` (string, required)
    Unique ID for API request
    Example: "2aa11828-1243-4026-8ee3-7b5c77cef796"