Availity Fetch prior auth

POSThttps://preview.ontross.com/api/integrations/availity/fetch-prior-auth

input.dashboard_id

string

required

Copy search-prior-auths.items[].dashboard_id for one item.

Example

"b28d4791-630e-4f8c-934a-19fc785b62d0"

input.customer_id

string

required

Copy search-prior-auths.items[].customer_id for the same item.

Example

"8741962"

input.dashboard_status

string

Copy search-prior-auths.items[].dashboard_status when present; the workflow can infer it from detail otherwise.

Example

"APPROVED"

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"

dashboard_id

string

Requested authorization item identifier echoed from the input.

Example

"b28d4791-630e-4f8c-934a-19fc785b62d0"

customer_id

string

Requested account identifier echoed from the input.

Example

"8741962"

workflow

object

Complete raw Availity viewDetails response, including serviceReviews, encounters, and payer-specific fields.

status_checks

array

Complete raw StatusCheckRealTime response for each service review, in serviceReviews order; includes payer notes and supplementalInformation.

attachments

array

Normalized attachment references extracted from every status check; copy all required fields from one entry to download-prior-auth-attachment. File bytes are downloaded separately.

attachments[].id

string

Use as attachment_id in download-prior-auth-attachment.

Example

"d96f412b-7ce8-4b30-a652-238d790ec145"

attachments[].file_name

string

Use as file_name in download-prior-auth-attachment.

Example

"clinical_summary.pdf"

attachments[].date_received

string

Original Availity dateReceived string; copy unchanged as date_received in download-prior-auth-attachment.

Example

"2026-09-14T15:32:08Z"

attachments[].size

integer

File length reported by payer metadata; downloaded byte count is returned by download-prior-auth-attachment.

Example

245760

attachments[].is_user_upload

boolean

Provider flag indicating whether a user uploaded the file.

Example

true

attachments[].payer_id

string

Use as payer_id in download-prior-auth-attachment.

Example

"00987"

attachments[].customer_id

string

Use as customer_id in download-prior-auth-attachment.

Example

"8741962"

attachments[].dashboard_id

string

Authorization item identifier copied from the workflow input.

Example

"b28d4791-630e-4f8c-934a-19fc785b62d0"

attachments[].service_review_id

string

ID of the workflow.serviceReviews entry whose status check produced this attachment.

Example

"f43021b8-596c-48ae-807b-62dc15379a04"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/availity/fetch-prior-auth \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"dashboard_id":"b28d4791-630e-4f8c-934a-19fc785b62d0","customer_id":"8741962","dashboard_status":"APPROVED"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "dashboard_id": "b28d4791-630e-4f8c-934a-19fc785b62d0",
    "customer_id": "8741962",
    "dashboard_status": "APPROVED"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "dashboard_id": "b28d4791-630e-4f8c-934a-19fc785b62d0",
    "customer_id": "8741962",
    "workflow": {},
    "status_checks": [
      {}
    ],
    "attachments": [
      {
        "id": "d96f412b-7ce8-4b30-a652-238d790ec145",
        "file_name": "clinical_summary.pdf",
        "date_received": "2026-09-14T15:32:08Z",
        "size": 245760,
        "is_user_upload": true,
        "payer_id": "00987",
        "customer_id": "8741962",
        "dashboard_id": "b28d4791-630e-4f8c-934a-19fc785b62d0",
        "service_review_id": "f43021b8-596c-48ae-807b-62dc15379a04"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}