API Environments
Subscribe to sandbox environment
Request for a sandbox environment account for a specific product category to familiarize yourself with our APIs before contracting to integrate our APIs for real-time API testing in your production environment.
- Sandbox URL:
https://sandbox-apigw.optum.com/apip/auth/v2/token
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 our interactive Try It interface or your development platform (Preferred method).
We provide a list of canned test service ID values to use in the sandbox environment sandbox predefined fields and values to view different responses. At any time, for more information, contact an Optum representative.
- 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 your secure sandbox credentials.
- 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 "canned patient" and “canned 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 sandbox test responses.
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.
Subscribe to production environment
NOTE
If you contract with Optum for API usage, use a separate credential pair issued by Optum for your production environment.
After successful sandbox testing, you can integrate our APIs for real-time usage in your production environment. To contract with us for a production environment, connect through your Optum AI Marketplace account or contact your Optum representative.
- Production URL:
https://apigw.optum.com/apip/auth/v2/token
- Reach out to sales at AI Marketplace or contact our Optum representative to contract for a production environment account and if you need help with 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
Updated 12 days ago