Readme

We offer you the following resources for our API documentation developer-focused resources.

In the Guides section, these resources are available:

• Quick start
• Security and authorization to access our APIs
• API test environment
• Overview of all our APIs
• Request and response contents for all the APIs
• API Examples
• JSON-to-EDI mapping
• Predefined fields and values for trying our APIs in sandbox
• Release notes
• Error messages
• FAQs (periodically updated)
• Troubleshooting

In the API Reference section, these resources are available:

• Overview of APIs

• Downloadable Swagger/OpenAPI spec (JSON), such as Eligibility API – application in JSON format that generates our documentation for developers to view and use

• Resources for API testing/trying

  • To try or test our APIs in your own a development platform/tool, download and import our OpenAPI spec provided above by clicking the Download OpenAPI Spec using 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.

  👍

  IMPORTANT

  The sandbox returns a canned response based on the received data. There is no validation check or confirmation of specifically required information. These checks would only occur in the production environment. You have to manually review the companion guides offered by the specific payers to confirm what is required for each.

For testing our APIs in the sandbox environment, you can edit the request body by using our Sandbox Predefined Fields and Values and Sandbox API Values and Test Responses, and send it to view a variety of responses by using a set of secure credentials provided.

📘

NOTE

DO NOT perform load testing or production data testing in the sandbox environment. Please use the sandbox ONLY to view sample API responses to HTTP requests using our sandbox predefined values and to familiarize yourself with our APIs.

For load testing and production data testing, we recommend using our APIs in the production environment.