Skip to main content

Medicaid API Reference

Public, aggregate-only Medicaid intelligence endpoints for module discovery and customer-facing app experiences.

GET /api/medicaid/intelligence/index.json

Returns the top-level endpoint directory and consumer guidance.

Request

ParameterTypeRequiredDescription
NoneNoPublic endpoint with no query params.

Example Request

# Fetch API index
curl -s https://orbdoc.com/api/medicaid/intelligence/index.json

Example Response

{
  "version": "2026-02-16",
  "endpoints": [
    "/api/medicaid/intelligence/catalog.json",
    "/api/medicaid/intelligence/module/:id.json"
  ],
  "consumer_notes": "Statistical context only; not payer prediction."
}

Error Codes

CodeMeaningFix
500Server errorRetry and check status page or support route.

Notes

  • No authentication required for public read endpoints.
  • Use this endpoint first in new integrations.

GET /api/medicaid/intelligence/catalog.json

Returns module catalog entries with maturity, gate status, and route references.

Request

ParameterTypeRequiredDescription
NoneNoPublic endpoint with no query params.

Example Request

# List available modules
curl -s https://orbdoc.com/api/medicaid/intelligence/catalog.json

Example Response

{
  "modules": [
    {
      "id": "policy-did-v2",
      "maturity": "shipped",
      "crossStateGateStatus": "pass",
      "route": "/medicaid/module/policy-did-v2"
    }
  ],
  "summary": {
    "availableModules": 8,
    "totalModules": 18
  }
}

Error Codes

CodeMeaningFix
500Catalog unavailableRetry and fallback to module index page.

Notes

  • Use `maturity` and `crossStateGateStatus` for UI badges.
  • For payload details, request `/module/:id.json`.

GET /api/medicaid/intelligence/module/:id.json

Returns one module payload with outputs, metadata, and release context.

Request

ParameterTypeRequiredDescription
`id`stringYesModule ID from catalog, e.g. `policy-did-v2`.

Example Request

# Fetch one module payload
curl -s https://orbdoc.com/api/medicaid/intelligence/module/policy-did-v2.json

Example Response

{
  "module": {
    "id": "policy-did-v2",
    "title": "Policy DiD Observatory",
    "maturity": "shipped"
  },
  "releaseEvidence": {
    "snapshot_id": "2026-02-16"
  }
}

Error Codes

CodeMeaningFix
404Unknown module IDUse `/catalog.json` to discover valid IDs.
500Server errorRetry and fallback to module route in UI.

Notes

  • Keep language non-adjudicative in downstream product copy.
  • Display maturity and release metadata to users.