API Environments

Sandbox

To request for a sandbox testing environment, sign up in the sandbox where you can review and familiarize yourself with our APIs without signing a contract and without any financial obligation before you use them in your production environment.

๐Ÿ“˜

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 predefined values and to familiarize yourself with our APIs.

To perform load testing and production data testing, we recommend using our APIs in production environment.

After receiving your client_id and client_secret for the sandbox environment, you can Try/test our APIs by using one of these options:

  • (Preferred method) A third-party application, such as a Postman tool/platform or any tool of your choice
  • Our Try It interactive view
  • Your own development console
  • Use our API URLs and Endpoints to access our APIs

We have a list of canned test service ID values to use in the sandbox environment sandbox predefined fields and values for testing a variety of responses by using a set of secure credentials provided.
At any time, for more information, contact an Optum representative.

  • For sandbox API testing, you can edit the request body and send it to the API engine to see what kinds of responses you will get.
  • The sandbox provides a set of predefined values that you can apply to see how the API works with claim data. It uses simulated Medical Service ID and Personal Medical Information (PMI). For successful use of sandbox APIs, you must use "fake patient" and โ€œfake providerโ€ values for your testing.

๐Ÿ‘

IMPORTANT

The sandbox returns canned responses 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 would need to manually review the companion guides offered by the specific payers to confirm what is required for each.

๐Ÿ“˜

NOTE

Do not use real-world values in our sandbox API endpoints! Doing so will produce errors.

We provide a list of Medical Service ID test values to use in sandbox so you can get a variety of different responses. See the Sandbox Test Responses document.

๐Ÿ“˜

NOTE

The JSON attributes in our APIs use snake-case, with the first letter of the attribute in lower case as in propertyCasualtyClaimNumber. Our APIs are case-sensitive and your JSON request body must observe this convention.

๐Ÿ‘

NOTE

For sandbox usage, all fields must have the correct predefined values to obtain a successful response. Inventing new PMI values or using real-world PMI values will result in errors. Please provide all of the values, such as tradingPartnerServiceId, controlNumber,subscriber, and so on marked as required (R) (see) in your API requests.

Production

๐Ÿ“˜

NOTE

If you contract with Optum for API usage, use a separate credential pair issued by Optum for your production API work.

Subscribe to production environment

  1. To request for a production environment account, reach out to sales @ [email protected] and for the following:
  • To either start a new contract
  • To have your contract-related questions answered
  • If you have an existing account and want to add additional products to it
  • Add/remove a product

Related Topics