Product
What am I integrating — a marketplace or fulfillment? Managed imaging fulfillment. You own checkout and the member experience; Scan books and delivers the report. You are not embedding an imaging marketplace. See Introduction and Is this API right for you?. Who charges the member? You. The displayed amount is your price, not a Scan checkout amount. Is there a price, quote, or live-availability API? No. Contracted terms plus your checkout plus Scan-managed scheduling. Nearby centers (GET /locations) apply to an existing referral, not a public search.
Invoices are post-scan, not a quote.
Authentication
How do I authenticate with the API? SendAuthorization: Bearer <api_token> on every request. Sandbox tokens come
from Get API keys. See Authentication.
What base URL should I use?
Sandbox is https://api.staging.scan.com with path prefix /api/v2. Production
is https://api.scan.com with the same /api/v2 prefix. Details are on
Authentication.
What if the token is lost or exposed?
It is shown once and cannot be recovered. Contact
[email protected] to revoke it and issue a replacement. Never
put it in browser code, URLs, logs, or chat.
Referrals and scheduling
How do I send a patient and physician order? Follow Submit a medical referral. How do I send safety answers on an existing referral? Follow Submit medical questions. How do I send preferred times on an existing referral? Follow Submit preferred times. Can Scan automatically choose and book the closest or soonest opening? Yes, when auto-book is enabled for your account. Follow Submit a booking. The call returns202; completion
arrives at the request webhook URL, then the account webhook URL, or by polling.
How do I send the order, safety answers, and preferred center together?
Follow Submit for scheduling.
Do I pick a timeslot myself?
No. Scan books from the preference you send.
Lines of business
I am a workers’ compensation payer or TPA. Which guide? Workers’ compensation and payers. I am an employer or benefit team. Which guide? Employers and benefit teams. I am a health plan. Which guide? Health plans.POST /api/v2/referrals
does not set line_of_business: health_plan today; that page covers how those
referrals appear on GET and webhooks.
Sandbox and testing
What are the sandbox limits? 2,000 successful requests or 7 days.4xx/5xx do not count. See
Errors and limits and
Testing.
Troubleshooting
I’m getting 401 / 403 / 422. See Errors and limits. IncludeX-Request-Id when you email
[email protected].
Where is the full API contract?
API tools and the API reference tab.
Webhooks
How do visit status events work? See Webhooks and Track referral status. Which statuses should I handle? Key offbooked, report_uploaded, and sent_to_rp. Full list:
Track referral status.
If you do not see your question here, email [email protected].