How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Photon

Photon Onboarding API

First-party onboarding endpoints for prescriber, developer, clinic, enterprise, platform, and other paths.

Documentation Provider Profile APIs.io OpenAPI GitHub

Photon Onboarding API is one of 5 APIs that Photon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 2026-05-13.

Requests are made against a single base URL, https://photonhealth.com.

4 operations 4 paths 16 schemas 1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-05-13
Base URL
https://clinical-api.photon.health/graphql
Authentication
API Key, API Key
Contact
Photon Health
Resource Areas
1

Authentication & Security 2

Photon Onboarding API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-onboarding-lead-token (leadTokenHeader). An API key is passed in the cookie as photon_onboarding_lead (leadTokenCookie).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Onboarding 4

First-party onboarding endpoints for prescriber, developer, clinic, enterprise, platform, and other paths.

GET
/api/onboarding/schema
Get onboarding paths, steps, and fields
getOnboardingSchema 1 param → 200
POST
/api/onboarding/sessions
Create or resume an onboarding session
createOrResumeOnboardingSession body → 200
PATCH
/api/onboarding/sessions/{sessionId}
Save or advance an onboarding step
saveOnboardingStep 1 param body → 200400401
POST
/api/onboarding/sessions/{sessionId}/submit
Submit a completed onboarding session
submitOnboardingSession 1 param body → 200401422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are OnboardingSession (20 properties), OnboardingField (9 properties), OnboardingFullPath (8 properties), SaveStepRequest (6 properties). Each schema is shown below with its type and property counts.

OnboardingSchema
object
4 properties 4 required
OnboardingMode
string
OnboardingStateEnvelope
object
1 property 1 required
Answers
object
OnboardingPathId
string
Public onboarding path id. Prefer /onboard?type={id} for new human links. Legacy /onboard{id} and /onboard{id}-{paymentplantier} links remain supported.
ErrorEnvelope
object
1 property 1 required
TrackingSummary
object
5 properties
OnboardingFullPath
object
8 properties 8 required
OnboardingSession
object
20 properties 4 required
SaveStepRequest
object
6 properties 1 required
OnboardingField
object
9 properties 3 required
SubmitRequest
object
4 properties
OnboardingPathChoice
object
5 properties 5 required
OnboardingStep
object
3 properties 3 required
ValidationErrorEnvelope
object
1 property 1 required
ProvisioningResult
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

photon-onboarding-api-openapi.yml Raw ↑

Other APIs Photon publishes across the network.

Photon Clinical API
AE Profile APIs.io
Photon Patient Benefits API
AE Profile APIs.io
Photon Agent discovery API
AE Profile APIs.io
Photon Newsletter API
AE Profile APIs.io
#Onboarding
← Back to P APIs
API Details
ID
photon:photon-onboarding-api
Base URL
https://clinical-api.photon.health/graphql
Docs
https://docs.photon.health/reference/clinical-api
Provider
Photon
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=photon-onboarding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/photon-onboarding-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Photon Onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.