availity · JSON Structure

Eligibility Subscriber Structure

Subscriber schema from Availity API

Type: object Properties: 7 Required: 1

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

Properties

memberId firstName lastName dateOfBirth gender ssn groupNumber

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/eligibility-subscriber-structure.json",
  "description": "Subscriber schema from Availity API",
  "type": "object",
  "required": [
    "memberId"
  ],
  "properties": {
    "memberId": {
      "type": "string",
      "description": "Insurance member ID"
    },
    "firstName": {
      "type": "string"
    },
    "lastName": {
      "type": "string"
    },
    "dateOfBirth": {
      "type": "date"
    },
    "gender": {
      "type": "string",
      "enum": [
        "M",
        "F",
        "U"
      ]
    },
    "ssn": {
      "type": "string",
      "description": "Social Security Number (last 4 or full)"
    },
    "groupNumber": {
      "type": "string"
    }
  },
  "name": "Subscriber"
}