Skip to main content
GET
/
api
/
eligibility
/
{id}
/
status
Get eligibility check status
curl --request GET \
  --url https://app.shasta.health/api/eligibility/{id}/status \
  --header 'Authorization: <api-key>'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "COMPLETED",
  "payer": {
    "payerName": "Aetna",
    "payerId": "60054",
    "entityIdentifier": "Payer",
    "entityType": "Non-Person Entity"
  },
  "subscriber": {
    "memberId": "XYZ123456",
    "firstName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "19800101",
    "groupNumber": "GRP001",
    "gender": "F",
    "address": {
      "address1": "123 Main St",
      "city": "Springfield",
      "state": "IL",
      "postalCode": "62701"
    }
  },
  "tradingPartnerServiceId": "60054",
  "planInformation": {
    "planName": "PPO Gold Plan",
    "insuranceType": "Preferred Provider Organization",
    "insuranceTypeCode": "PR"
  },
  "planDateInformation": {
    "eligibility": "20240101",
    "plan": "20240101-20241231"
  },
  "planActive": true,
  "providerNetwork": {
    "status": "In Network",
    "tier": "Tier 1",
    "specialty": "General Practice"
  },
  "benefits": [
    {
      "serviceType": "Medical Nutrition",
      "inNetwork": true,
      "copay": 30,
      "deductible": 500,
      "deductibleRemaining": 200,
      "deductibleApplies": true,
      "outOfPocketMax": 5000,
      "outOfPocketRemaining": 3000,
      "visitLimit": 20,
      "visitsUsed": 5,
      "authorizationRequired": false,
      "confidence": {
        "score": 0.9,
        "criteria": [
          "Copay confirmed on payer portal benefits page",
          "Visit limit matched across two portal sections"
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Pass your API key as Key <your-api-key>. Example: Authorization: Key sk_abc123

Path Parameters

id
string
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Current status of the eligibility check.

Response returned immediately after submitting an eligibility check. The check is processed asynchronously — poll /api/eligibility/{id}/status to track completion.

id
string
required

Unique identifier for the eligibility check. Use this to poll status.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status
enum<string>
required

Processing status, e.g. IN_PROGRESS, COMPLETED, FAILED.

Available options:
IN_PROGRESS,
COMPLETED,
FAILED
Example:

"IN_PROGRESS"

provider
object

The rendering or billing provider on the eligibility check.

payer
object
subscriber
object
dependents
object[]
tradingPartnerServiceId
string
planInformation
object
planDateInformation
object
planActive
boolean
planCoverage
string
providerNetwork
object
benefits
object[]
additionalNotes
string | null
errors
object[]
warnings
object[]
benefitsInformation
object[]
confidence
object
meta
object
subscriberTraceNumbers
object[]
x12
string

Raw X12 EDI transaction string.