⌘K

Beacon Ingest & SMART Health Cards

Document upload (PDF, FHIR bundles), SMART Health Card verification, virus scanning, and secure ingest boundary for partner integrations.

Live API Status — Beacon Ingest & SMART Health Cards

Probing production endpoints…

Rate Limits & SLA

Rate limit

500 uploads/min

Burst

30 req/sec

Uptime SLA

99.9%

Support

Business hours · 4h

P95 latency

< 5s finalize

Retention

Documents 7y

PDF+FHIR

Formats

Document & bundle ingest

SHC

Verification

SMART Health Cards

AV Scan

Security

Malware protection

OAuth

Auth

Partner credentials

Capabilities

OpenAPI contract

Machine-readable spec: apex-ingest-boundary.openapi.yaml

Download apex-ingest-boundary.openapi.yaml

Integration toolkit

Official SDKs

Apex Beacon certification track

12 required items · platform + product-specific checks

Full checklist →
  • First authenticated API call in sandbox
  • OAuth or API key with least-privilege scopes
  • FHIR R4 read against sandbox lake
  • GPID boundary headers on write paths
  • Webhook HMAC-SHA256 verification implemented
  • Webhook idempotency by delivery ID

+9 more on the certification page

Complete all required items before production go-live

Webhook events for Apex Beacon

Subscribe at /webhooks — verify HMAC-SHA256 signatures

Event catalog →
ingest.completeBeacon / Ingest

Document or FHIR bundle ingest normalized and stored.

{
  "event": "ingest.complete",
  "document_id": "doc_xyz789",
  "gpid": "APX-1A2B3C4D",
  "match_status": "deterministic_match",
  "lake_resource_id": "Patient/abc"
}
ingest.rejectedBeacon / Ingest

Ingest rejected — virus scan, validation, or policy failure.

{
  "event": "ingest.rejected",
  "document_id": "doc_xyz789",
  "reason": "MALWARE_DETECTED",
  "rejected_at": "2026-06-13T19:55:00Z"
}