Skip to main content
POST
/
v1
/
prior-auth
/
authorizations
/
{authorization_id}
/
cancel
Cancel Authorization
curl --request POST \
  --url https://api.example.com/v1/prior-auth/authorizations/{authorization_id}/cancel
{
  "id": "<string>",
  "workflowState": "needs_input",
  "decisionState": "unknown",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "template": {
    "id": "<string>",
    "version": "<string>",
    "sourceName": "<string>",
    "effectiveDate": "2023-11-07T05:31:56Z"
  },
  "questionnaire": [
    {
      "id": "<string>",
      "title": "<string>",
      "items": [
        {
          "linkId": "<string>",
          "text": "<string>",
          "required": true,
          "answerType": "string"
        }
      ]
    }
  ],
  "requirements": {
    "questions": [
      {
        "linkId": "<string>",
        "required": true,
        "answered": true
      }
    ],
    "documents": [
      {
        "key": "<string>",
        "label": "<string>",
        "required": true,
        "provided": true,
        "message": "<string>"
      }
    ],
    "issues": [
      {
        "code": "<string>",
        "message": "<string>",
        "field": "<string>",
        "severity": "error",
        "blocking": true
      }
    ]
  },
  "submissionChannel": "efax",
  "answers": {},
  "attachments": [
    {
      "id": "<string>",
      "fileId": "<string>",
      "label": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "actions": [
    {
      "id": "<string>",
      "type": "payer_request_for_information",
      "status": "open",
      "message": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "requestedDocuments": [
        "<string>"
      ],
      "resolutionHint": "<string>",
      "resolutionNote": "<string>",
      "resolvedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "previewFile": {
    "id": "<string>",
    "status": "pending_upload",
    "fileName": "<string>",
    "contentType": "application/pdf",
    "purpose": "authorization_attachment",
    "createdAt": "2023-11-07T05:31:56Z",
    "sizeBytes": 123,
    "completedAt": "2023-11-07T05:31:56Z",
    "uploadUrl": "<string>",
    "downloadUrl": "<string>"
  },
  "latestSubmissionAttempt": {
    "id": "<string>",
    "authorizationId": "<string>",
    "status": "pending",
    "submissionReference": "<string>",
    "acceptedAt": "2023-11-07T05:31:56Z",
    "confirmedAt": "2023-11-07T05:31:56Z",
    "errorCode": "<string>",
    "errorMessage": "<string>"
  }
}

Path Parameters

authorization_id
string
required

Response

Successful Response

id
string
required
workflowState
enum<string>
required
Available options:
needs_input,
ready_to_submit,
submitting,
pending_payer,
action_required,
completed,
cancelled
decisionState
enum<string>
required
Available options:
unknown,
pending,
approved,
denied
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
template
TemplateInfo · object
required
questionnaire
QuestionnaireGroup · object[]
required
requirements
Requirements · object
required
submissionChannel
enum<string> | null
Available options:
efax
answers
object
attachments
AuthorizationAttachment · object[]
actions
ActionItem · object[]
previewFile
FileDto · object
latestSubmissionAttempt
SubmissionAttempt · object