Availity · Schema

ClaimAttachmentRequest

ClaimAttachmentRequest schema from Availity API

HealthcareClearinghouseHIPAAX12 EDIEligibilityClaimsPrior AuthorizationRevenue Cycle ManagementPayersPrice Transparency

Properties

Name Type Description
payerId string
claimNumber string
provider object
attachmentType string
attachments array
View JSON Schema on GitHub

JSON Schema

claim-attachments-claim-attachment-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/availity/refs/heads/main/json-schema/claim-attachments-claim-attachment-request-schema.json",
  "title": "ClaimAttachmentRequest",
  "description": "ClaimAttachmentRequest schema from Availity API",
  "type": "object",
  "required": [
    "payerId",
    "claimNumber",
    "provider",
    "attachments"
  ],
  "properties": {
    "payerId": {
      "type": "string",
      "example": "BCBS001"
    },
    "claimNumber": {
      "type": "string",
      "example": "CLM-2025-001234"
    },
    "provider": {
      "type": "object",
      "properties": {
        "npi": {
          "type": "string",
          "example": "1234567890"
        }
      }
    },
    "attachmentType": {
      "type": "string",
      "enum": [
        "STRUCTURED",
        "UNSTRUCTURED"
      ],
      "example": "UNSTRUCTURED"
    },
    "attachments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contentType": {
            "type": "string",
            "example": "application/pdf"
          },
          "title": {
            "type": "string",
            "example": "Operative Report"
          },
          "data": {
            "type": "string",
            "format": "byte"
          }
        }
      }
    }
  }
}