Optum

Optum Attachment Status API

The Attachment Status API from Optum — 2 operation(s) for attachment status.

GitHub OpenAPI

Operations 2

GET /{traceId} Endpoint to retrieve the attachment status based on traceId #
POST /metadata Endpoint to retrieve the attachment status based on metadata #

Documentation

📖
APIReference
https://developer.optum.com/eligibilityandclaims/reference/api-overview
📖
GettingStarted
https://developer.optum.com/eligibilityandclaims/docs/get-started-with-optum-api
📖
Authentication
https://developer.optum.com/eligibilityandclaims/docs/optum-security-and-authorization
📖
APIReference
https://developer.optum.com/optumreal-dental/reference/overview-real-dental
📖
GettingStarted
https://developer.optum.com/optumreal-dental/reference/get-started
📖
APIReference
https://developer.optum.com/pharmacysolutions/reference
📖
APIReference
https://developer.optum.com/paymentandreimbursement/reference
📖
APIReference
https://developer.optum.com/platformandinteroperability/reference
📖
APIReference
https://developer.optum.com/analyticsandinsights/reference
📖
APIReference
https://developer.optum.com/apitools/reference/security-and-authorization-v2-overview
📖
Documentation
https://developer.optum.com/apitools/docs/getting-started

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optum/refs/heads/main/openapi/optum-attachment-status-api-openapi.yml

Other Resources

🔗
ChangeLog
https://developer.optum.com/eligibilityandclaims/docs/eligibility-release-notes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optum-attachment-status-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optum-attachment-status-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Medical Network v1 Attachment Status API
  description: Optum's Attachment Status API.
  contact:
    email: imn-attachments@uhgazure.onmicrosoft.com
  version: '1'
servers:
- url: https://sandbox-apigw.optum.com/medicalnetwork/attachments/status/v1
security:
- bearerToken: []
tags:
- name: Attachment Status
paths:
  /{traceId}:
    get:
      tags:
      - Attachment Status
      summary: Endpoint to retrieve the attachment status based on traceId
      description: This endpoint used to retrieve the status of attachments submitted by submitter or payer.
      parameters:
      - name: traceId
        in: path
        description: attachment submitted traceId
        required: true
        schema:
          type: string
      - name: fieldset
        in: query
        description: It must be either 'summary' or 'detail'. Default value is 'summary'
        required: true
        schema:
          type: string
          enum:
          - summary
          - detail
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailedResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: getByTraceId
      x-operation-id-source: derived
  /metadata:
    post:
      tags:
      - Attachment Status
      summary: Endpoint to retrieve the attachment status based on metadata
      description: This endpoint used to retrieve the status of attachments submitted by submitter or payer.
      requestBody:
        description: metadata json
        content:
          application/json:
            schema:
              required:
              - transactionReceivedEndDate
              - transactionReceivedStartDate
              type: object
              properties:
                submitterId:
                  type: string
                  description: Filter transaction status using Submitter ID
                payerId:
                  type: string
                  description: Filter transaction status using Payer ID
                claimStartDate:
                  type: string
                  description: Filter transaction status using Claim Start Date. Date should be YYYY-MM-DD
                  example: YYYY-MM-DD
                claimEndDate:
                  type: string
                  description: Filter transaction status using Claim End Date. Date should be YYYY-MM-DD
                  example: YYYY-MM-DD
                transactionReceivedStartDate:
                  type: string
                  description: Filter transaction status using Transaction Received Start Date. Date should be YYYY-MM-DD
                  example: YYYY-MM-DD
                transactionReceivedEndDate:
                  type: string
                  description: Filter transaction status using Transaction Received End Date. Date should be YYYY-MM-DD
                  example: YYYY-MM-DD
                claimNumber:
                  type: string
                  description: Filter transaction status using Claim Control Number
                patientFirstName:
                  type: string
                  description: Filter transaction status using Patient First Name
                patientLastName:
                  type: string
                  description: Filter transaction status using Patient Last Name
                memberId:
                  type: string
                  description: Filter transaction status using Member ID
                providerId:
                  type: string
                  description: Filter transaction status using Provider ID
                providerFirstName:
                  type: string
                  description: Filter transaction status using Provider First Name
                providerLastName:
                  type: string
                  description: Filter transaction status using Provider Last Name
                payerName:
                  type: string
                  description: Filter transaction status using Payer Name
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataResponses'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codegen-request-body-name: data
      operationId: postMetadata
      x-operation-id-source: derived
components:
  schemas:
    DetailedResponse:
      type: object
      properties:
        transactionDetails:
          type: object
          allOf:
          - $ref: '#/components/schemas/TransactionDetails'
        status:
          type: array
          items:
            $ref: '#/components/schemas/StatusDetails'
    BadRequest:
      allOf:
      - $ref: '#/components/schemas/ErrorResponse'
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: string
        statusMessage:
          type: string
      example:
        statusCode: ErrorResponseCode
        statusMessage: SystemErrors.INTERNAL_ERROR
    NotAuthorized:
      allOf:
      - $ref: '#/components/schemas/UnAuthorized'
    MetadataResponses:
      type: array
      items:
        $ref: '#/components/schemas/MetadataResponse'
    StatusDetails:
      type: object
      properties:
        statusMessage:
          type: string
        statusCode:
          type: string
        statusTimeStamp:
          type: string
        documents:
          type: array
          items:
            $ref: '#/components/schemas/DocumentDetails'
    MetadataResponse:
      type: object
      properties:
        traceId:
          type: string
        transactionDetails:
          type: object
          allOf:
          - $ref: '#/components/schemas/TransactionDetails'
        status:
          type: array
          items:
            $ref: '#/components/schemas/StatusDetails'
    UnAuthorized:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
      example:
        error: invalid_request
        error_description: The access token is missing
    TransactionDetails:
      type: object
      properties:
        submitterId:
          type: string
        payerId:
          type: string
        payerName:
          type: string
        memberId:
          type: string
        patientFirstName:
          type: string
        patientLastName:
          type: string
        providerId:
          type: string
        providerFirstName:
          type: string
        providerLastName:
          type: string
        transactionSubmittedDate:
          type: string
        rejectionInformation:
          type: string
    DocumentDetails:
      type: object
      properties:
        documentName:
          type: string
        controlNumber:
          type: string
        statusCode:
          type:
          - string
          - 'null'
        statusMessage:
          type:
          - string
          - 'null'
        statusTimeStamp:
          type:
          - string
          - 'null'
        rejectionInformation:
          type:
          - string
          - 'null'
  securitySchemes:
    bearerToken:
      type: apiKey
      name: Authorization
      in: header