availity · JSON Structure

Claim Status Summary Search Request Structure

SummarySearchRequest schema from Availity API

Type: object Properties: 8 Required: 2

SummarySearchRequest is a JSON Structure definition published by availity, describing 8 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

payerId requestType memberId fromDate toDate providerNpi checkNumber requestedStatus

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/availity/refs/heads/main/json-structure/claim-status-summary-search-request-structure.json",
  "description": "SummarySearchRequest schema from Availity API",
  "type": "object",
  "required": [
    "payerId",
    "requestType"
  ],
  "properties": {
    "payerId": {
      "type": "string",
      "example": "BCBS001"
    },
    "requestType": {
      "type": "string",
      "enum": [
        "SERVICE_DATE",
        "MEMBER_ID"
      ],
      "example": "SERVICE_DATE"
    },
    "memberId": {
      "type": "string",
      "example": "MEM123456"
    },
    "fromDate": {
      "type": "date",
      "example": "2025-01-01"
    },
    "toDate": {
      "type": "date",
      "example": "2025-12-31"
    },
    "providerNpi": {
      "type": "string",
      "example": "1234567890"
    },
    "checkNumber": {
      "type": "string",
      "example": "CHK-001234"
    },
    "requestedStatus": {
      "type": "string",
      "example": "PAID"
    }
  },
  "name": "SummarySearchRequest"
}