Try Our APIs

📘

BEARER TOKEN LIFESPAN

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

If you do not own a development platform to test run our APIs, you can create a sandbox and try our APIs using one of two methods: Postman tool or interactive Try It interface.

📘

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

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

Using Postman

To test our APIs, use Postman (preferred method to test run our APIs) or any other API tool/platform of your choice, quickly submit API requests to our gateways by importing our OpenAPI Spec collection in the required Optum API. You just need to create an account and set up a workspace. For information about working with our Postman collections, see using Postman collection.

📘

NOTE

Postman is a third-party API tool/platform and not associated with Optum. The tool enables you to test our RESTful APIs.

Using interactive Try It interface

You can run our API requests directly in this interface and view an actual response to the API request. For more information about how to use this interactive interface, see using Try It interface.

📘

NOTE

See API URLs and endpoints for a list of our API endpoints.

👍

IMPORTANT

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 example) in your API requests.

Related Topics