Developer portal

Technical guidance for institutions evaluating the SmartVax portal and partner API.

Public documentation stays focused on how SmartVax fits into enrollment, compliance, transfer, and parent-upload workflows. Signed-in staff can view the concrete request examples, headers, and endpoint patterns used during sandbox onboarding.

Sandbox onboardingPartner APICustomer-facing portalPrivate internal services
Customer-facing portal

What external teams should understand first

Guardian portal
Collect records without sending families into a back-office workflow
Parents and guardians can upload vaccine cards, PDFs, provider forms, and transfer paperwork in a browser-first intake flow.
Staff workspace
Keep reviewers in one operational queue
Staff can review source documents, structured extractions, compliance status, and secure packet actions from the same SmartVax workspace.
Transfer packets
Move records between institutions securely
SmartVax generates shareable packets and audit-aware disclosure workflows for school changes, provider handoff, and inbound record requests.
Partner integrations
Connect SIS, CRM, and case-management systems without exposing internal services
Public partner APIs stay narrow and controlled while the SmartVax internal API remains private.
Partner lifecycle

How SmartVax expects integration projects to roll out

Sandbox-first onboarding
Start with synthetic tenants, validate mappings, then promote the same integration pattern to production after security review.
Institution-oriented data model
Sync child, guardian, enrollment, compliance, packet, and share workflow state into your operational systems using external IDs.
Microsoft Dynamics and downstream operations
Map SmartVax records into Dynamics, Power Automate, data warehouse, or case-management flows without rebuilding the intake experience.
Evaluation guidance

What the public documentation covers

Portal surfaces

Guardian intake, staff review, secure packet sharing, and institutional workflows.

Integration scope

Roster sync, compliance reads, secure transfers, and sandbox-to-production promotion.

Security posture

Customer-facing docs stay high level and do not expose internal services or implementation details that do not help onboarding.

Internal examples

Signed-in SmartVax staff can view request examples, rollout notes, and API-key operations below.

Staff-only details

Implementation examples stay behind SmartVax staff authentication.

Signed-in staff can view example payloads, header conventions, and rollout guidance for sandbox and production partner integrations.