API Health Check

All of our APIs have a /healthcheck endpoint, which verifies that the operating status of the requested API is optimal. It is a ping for the API entry points to ensure the entry points are accessible and it is the first thing you can do if the API request is not working. See API Example.

Performing the API health check (for first-time users)

• To run the health check for the Eligibility V3 API, download and import the Eligibility interactive OpenAPI Spec from the Overview page in to your own development platform or a tool of your choice. You can use our sandbox predefined values to familiarize yourself with our APIs. You can create a sandbox and try our APIs for real-time API testing.
• If you do not own a development platform/tool to try or test our APIs, use our interactive Try It interface to familiarize yourself with our APIs, for example, API Example. For information, see use the Try It interface. You can create a sandbox and try our APIs for real-time API testing.