Tross
AVAILITY

Download prior auth attachment

Download and store one authorization attachment.

POSThttps://api.ontross.com/api/integrations/availity/download-prior-auth-attachment
Request Fields
input.attachment_id
string
required
Copy fetch-prior-auth.attachments[].id for one attachment.
Example
"8c4d61a2-79e5-4b03-a6f8-2d917c54be30"
input.file_name
string
required
Copy the same attachment's file_name unchanged.
Example
"clinical_notes.pdf"
input.date_received
string
required
Copy the same attachment's original date_received string unchanged.
Example
"2026-09-14T15:32:08Z"
input.payer_id
string
required
Copy the same attachment's payer_id unchanged, including leading zeroes.
Example
"00987"
input.customer_id
string
required
Copy the same attachment's customer_id unchanged.
Example
"8741962"
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
attachment_id
string
Requested document reference, checked against the downloaded response.
Example
"8c4d61a2-79e5-4b03-a6f8-2d917c54be30"
file_name
string
Original requested filename, not extracted from the downloaded response.
Example
"clinical_notes.pdf"
attachment_details
object
Complete raw Availity attachment status response; attachmentContents is only the relative document path.
file
object
Metadata for the downloaded document. Download the ZIP archive from the response's top-level files field and extract file.archive_path.
file.archive_path
string
Name of the downloaded document inside the ZIP archive linked by the response's top-level files field.
Example
"clinical_notes.pdf"
file.content_type
string
HTTP Content-Type of the downloaded document.
Example
"application/pdf"
file.content_disposition
string
HTTP Content-Disposition, including Availity's download filename when supplied.
Example
"attachment; filename=\"clinical_notes.pdf\""
file.size_bytes
integer
Number of downloaded file bytes.
Example
235516
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/availity/download-prior-auth-attachment \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"attachment_id":"8c4d61a2-79e5-4b03-a6f8-2d917c54be30","file_name":"clinical_notes.pdf","date_received":"2026-09-14T15:32:08Z","payer_id":"00987","customer_id":"8741962"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "attachment_id": "8c4d61a2-79e5-4b03-a6f8-2d917c54be30",
    "file_name": "clinical_notes.pdf",
    "date_received": "2026-09-14T15:32:08Z",
    "payer_id": "00987",
    "customer_id": "8741962"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "attachment_id": "8c4d61a2-79e5-4b03-a6f8-2d917c54be30",
    "file_name": "clinical_notes.pdf",
    "attachment_details": {},
    "file": {
      "archive_path": "clinical_notes.pdf",
      "content_type": "application/pdf",
      "content_disposition": "attachment; filename=\"clinical_notes.pdf\"",
      "size_bytes": 235516
    }
  },
  "files": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}