Availity · Schema

DetailSearchRequest

DetailSearchRequest schema from Availity API

HealthcareClearinghouseHIPAAX12 EDIEligibilityClaimsPrior AuthorizationRevenue Cycle ManagementPayersPrice Transparency

Properties

Name Type Description
payerId string
claimNumber string
requestType string
providerTaxId string
providerNpi string
processedDate string
View JSON Schema on GitHub

JSON Schema

claim-status-detail-search-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-status-detail-search-request-schema.json",
  "title": "DetailSearchRequest",
  "description": "DetailSearchRequest schema from Availity API",
  "type": "object",
  "required": [
    "payerId",
    "claimNumber",
    "requestType"
  ],
  "properties": {
    "payerId": {
      "type": "string",
      "example": "BCBS001"
    },
    "claimNumber": {
      "type": "string",
      "example": "CLM-2025-001234"
    },
    "requestType": {
      "type": "string",
      "enum": [
        "CLAIM_NUMBER"
      ],
      "example": "CLAIM_NUMBER"
    },
    "providerTaxId": {
      "type": "string",
      "example": "123456789"
    },
    "providerNpi": {
      "type": "string",
      "example": "1234567890"
    },
    "processedDate": {
      "type": "string",
      "format": "date",
      "example": "2025-03-15"
    }
  }
}