API Onboarding

Optum API onboarding process ensures that our API customers automate their API consumption process and helps API users solve problems and successfully complete the medical network tasks. Experience the best user experience with our API that enables you to develop and automate several tasks without examining how the APIs work.

• 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.
• Use your own development workflow and test or try our APIs by downloading our interactive OpenAPI spec (go to API Reference section >> Overview section of the product that you want to test, and click Download OpenAPI Spec) using our sandbox predefined values to familiarize yourself with our APIs.

📘

NOTE

1. HTTPS: Optum APIs are only accessible through HTTPS
2. JSON: Request and response contents are in JSON format
3. OAuth: All Optum API requests are protected by OAuth2 Bearer authorization token to obtain access

Security and Authorization Protocols and Implementation

A data entry console to make claims requests

All providers' offices need an effective and straightforward console for creating and filing new claims, with the common knowledge shared across the team reflected across the user interface (UI).

Automate API bearer token usage, using OAuth2 token retrieval

Apply the same token across all transactions during the full token lifespan and automatically refresh the token just before it expires.

Token automation

1. Get a unique authorization token for each transaction;
2. Apply the same token across all transactions during the token lifespan and automatically refresh the token just before it expires.

📘

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.

Optum API URLs

📘

NOTE

The JSON attributes in our APIs use camel-case, with the first letter of the attribute in lower case as in tradingPartnerServiceId (this is the Payer ID). Here is a list of test Trading Partner Service IDs. Our APIs are case-sensitive and your JSON request body must observe this convention.

Use our REST APIs with these HTTP URLs.

• Sandbox URL

https://sandbox-apigw.optum.com/medicalnetwork/

https://apigw-optum.com/medicalnetwork/

For more details, see Access the Optum APIs.

API endpoint usage example

A request contains an HTTPS/URL and endpoint. See the API Endpoint Usage example.

Abstract the complex data needed for a successful request

API users can easily make requests and efficiently get responses.
For example, the controlNumber field exists in all of our APIs as a required value that the provider or institution generates to identify each transaction. When the provider's office sends a request, they do not need to worry about defining and entering these values as they are programmatically handled.

Audit and track all transactions

This includes tracking of all the controlNumber, payer ID, and patient information for effective cross-referencing.

Use our REST APIs

Use your access credentials provided by Optum.
The credential set consists of a random alphanumeric client_id and client_secret pair. Contact your Optum representative if you do not have this information.

📘

NOTE

Optum strongly recommends you carefully guard your API access credentials. Avoid sharing them with others.

Optum API Healthcheck

Optum provides a /healthcheck endpoint in all of the APIs (for example, Eligibility, Professional Claims v3, Claim Responses and Reports (ERA), and so on) to verify that the operating status of the API is accessible and is optimal. It is the first thing you can do if something goes wrong. For more information, see checking the operating status of API.

Metadata for troubleshooting

Optum Medical Network APIs support a significant troubleshooting feature called metadata.

📘

NOTE

API users need not enable this capability; it is automatic and has no effect on information in any medical transaction. If you encounter any issues with a transaction and need to work with Optum technical support, provide the values provided in the meta object to the Optum representative for troubleshooting.

Prerequisites to use our APIs

Our APIs are private and require credentials to gain access Sign in and request for API credentials.

API components

API credentials

1. Your API credentials include the following information in an API request.

📘

NOTE

You should have two sets of credentials:

• One for the sandbox — to help you test our APIs before signing a contract
• One for production — provided after signing a contract or after processing a subscription

These credentials are specific and unique to an API environment and your company.

Bearer token

2. A Bearer token.
   The /apip/auth/v2/token/ endpoint allows you to obtain a short-lived access token that must be transmitted with subsequent API requests.

📘

BEARER TOKEN LIFESPAN

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

Sandbox credentials

For sandbox credentials, see.

Try our APIs

If you do not own a development platform to sample the APIs, you can Try our APIs using our interactive Try It interface by using our sandbox predefined values to familiarize yourself with our APIs. For example, generate a bearer token. For information about testing our APIs in the interactive Try It interface, see using the Try It interface. Download our OpenAPI Spec locally and view the specification by clicking the Download OpenAPI Spec button in each of the product overview of the API Reference section .

• To download locally and view the specification (optional), click Download OpenAPI Spec.

Related Topics

• The API Workflow section in the left pane in the developer portal provides information about the required API workflows.
• API URLs and Endpoints
• API Environments
• using the Try It interface
• API FAQs