API Example Attachments Status API

Suggest Edits

curl --request GET \
     --url 'https://sandbox-apigw.optum.com/medicalnetwork/attachments/status/v1/6022b1ad-779a-2956-b2cb-57f3afa9f102?fieldset=summary' \
     --header 'Authorization: Bearer eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnI...' \
     --header 'accept: application/json'

[
  {
    "statusCode": "01",
    "statusMessage": "TRANSACTION_RECEIVED",
    "statusTimeStamp": "2025-10-09T17:11Z",
    "documents": [
      {
        "documentName": "CustomPayerConfig Design.jpg",
        "controlNumber": "123456789"
      }
    ]
  }
]

curl --request POST \
     --url https://sandbox-apigw.optum.com/medicalnetwork/attachments/status/v1/metadata \
     --header 'Authorization: Bearer eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnI...' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "transactionReceivedStartDate": "2025-10-09",
  "transactionReceivedEndDate": "2025-10-09"
}
'

[
  {
    "traceId": "6022b1ad-779a-2956-b2cb-57f3afa9f102",
    "transactionDetails": {
      "submitterId": "999898",
      "memberId": "0000000001",
      "patientFirstName": "johnone",
      "patientLastName": "doeone",
      "payerId": "TESTEP01",
      "providerId": "1760854442",
      "providerFirstName": null,
      "providerLastName": "happy doctors group",
      "claimStartDate": "2005-05-13",
      "claimEndDate": "2005-05-14",
      "payerName": "unknown",
      "transactionSubmittedDate": "2025-10-09T17:10Z",
      "rejectionInformation": null
    },
    "status": [
      {
        "statusCode": "01",
        "statusMessage": "TRANSACTION_RECEIVED",
        "statusTimeStamp": "2025-10-09T17:11Z",
        "documents": [
          {
            "documentName": "CustomPayerConfig Design.jpg",
            "controlNumber": "123456789"
          }
        ]
      }
    ]
  }
]

```json
Date format: "yyyy-MM-dd'T'HH:mm'Z'"
 
Sample response:
{
    "transactionDetails": {
        "submitterId": "TESTSBMTR11111",
        "memberId": "0000000001",
        "patientFirstName": "doeone",
        "patientLastName": "johnone",
        "payerId": "TESTEP10",
        "providerId": "1760854442",
        "providerFirstName": null,
        "providerLastName": "happy doctors group",
        "claimStartDate": "2005-05-14",
        "claimEndDate": "2005-05-14",
        "payerName": "VA HEALTH SYSTEM",
        "rejectionInformation": "File type not supported"
    },
    "status": [
        {
            "statusCode": "10",
            "statusMessage": "PARTIALLY_ACCEPTED",
            "statusTimeStamp": "2021-08-20T13:25Z",
            "documents": [
                {
                    "documentName": "rightarm.jpg",
                    "controlNumber": "123456789",
                    "statusCode": "06",
                    "statusMessage": "ACCEPTED_BY_PAYER",
                    "statusTimeStamp": "2021-08-20T13:25Z"
                },
                {
                    "documentName": "rightarm1.jpg",
                    "controlNumber": "123456789",
                    "statusCode": "52",
                    "statusMessage": "REJECTED_BY_PAYER",
                    "statusTimeStamp": "2021-08-20T13:25Z",
                    "rejectionInformation": "File type not supported"
                }
            ]
        }
    ]
}
```

Time stamp values show both the date and time in a specific format. Each individual attachment file in the submission gets a separate object as a part of the overall response. This is how you will find out the state of a partial acceptance of attachments from the payer.

For submissions with more than one attachment, you will receive a Partial Acceptance notification as part of the response should one or more submitted files not be accepted.

In the preceding example, you see that accepted attachments will simply receive an acceptance time stamp. Rejected attachments will receive a rejectionInformation field briefly describing the reason.