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 details with examples in API Health Check.

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 to try or test our APIs, use our interactive Try It interface to familiarize yourself with our APIs, for example, generate a bearer token. For information, see using the Try It interface. You can create a sandbox and try our APIs for real-time API testing.

Generate a bear token

Our API servers require bearer tokens to access our APIs.

Using your own development platform or tool

1. Generate a Bearer token using the [/apip/auth/v2/token](https://sandbox-apigw.optum.com/apip/auth/v2/token) endpoint.

📘

BEARER TOKEN LIFESPAN

The lifespan of a Bearer token is one hour (3600 seconds) for both sandbox and production environments.

We recommend automating transactions to use the tokens generated over the token lifespan. Obtaining tokens for each transaction is less efficient and does not improve the security criteria for any transactions.

2. Run the /healthcheck endpoint.

https://sandbox-apigw.optum.com/medicalnetwork/eligibility/v3/healthcheck

If the API engine is working correctly and if the entry points are accessible, the API operating status response shows OK.

Using our development portal's Try It interface

1. Go to API Reference.

Generate a bearer token

1. Click the API Tools tab.
2. Click /apip/auth/v2/token.
3. Enter the following values in their respective fields or use the repopulated values by clicking and selecting the respective values.

📘

NOTE

To view the request example, pull down the Example drop-down above the Try It button.

5. Click Try It to generate a bearer token.

Run an API health check

1. Go to API Reference.
2. In the left navigation, click Health Check on the required API.
3. Enter the bearer token generated in the Authorization field by performing step 5.
4. Click Try It.
   The response to the requested API shows.

📘

NOTE

A response other than a 200 OK, indicates that the API health check failed.