Developer Documentation · Badge Embed

Facility Badge Embed

CMS-listed healthcare facilities can embed a Fonteum badge on their website. Pass a 6-character CMS Certification Number (CCN) to receive an inline SVG badge or an HTML iframe snippet. No authentication required.

GET /api/badge Dataset catalog docs FHIR R4 API docs

Quickstart

Two query parameters. One endpoint.

The CCN is the 6-character CMS Certification Number assigned to every CMS-certified facility. You can find it on the CMS Care Compare facility page or in the /api/fhir/Organization response.

# SVG badge (default)
curl -s "https://fonteum.com/api/badge?ccn=015009" > badge.svg

# HTML iframe embed snippet
curl -s "https://fonteum.com/api/badge?ccn=015009&format=html"
# → <iframe src="https://fonteum.com/api/badge?ccn=015009" ...></iframe>

# Check whether a CCN is in the catalog (404 = not found)
curl -sI "https://fonteum.com/api/badge?ccn=999999" | grep HTTP
# → HTTP/2 404

Embed snippet

Paste the iframe into your facility website.

Replace YOUR_CCNwith your facility’s 6-character CCN. The badge is 240 x 72 px and renders inline — no JavaScript, no layout shift.

<!-- Paste this snippet into your facility website -->
<iframe
  src="https://fonteum.com/api/badge?ccn=YOUR_CCN"
  width="240"
  height="72"
  frameborder="0"
  scrolling="no"
  title="Listed on Fonteum"
></iframe>

Parameters

Two query parameters. Both optional.

Parameter	Type	Description
`ccn`	`string`	6-character CMS Certification Number. Omit to receive the badge program schema doc (JSON).
`format`	`string`	svg (default) — returns image/svg+xml. html — returns a text/html iframe embed snippet.

Response codes

200, 400, 404, 429, 500. No auth errors.

Code	Condition
`200`	CCN found — returns SVG or HTML embed snippet depending on format param. Also returned when no CCN is provided (returns JSON schema doc).
`400`	ccn is present but not a valid 6-character alphanumeric CMS Certification Number.
`404`	CCN not found in the CMS provider registry.
`429`	Rate limit exceeded — retry after the interval in the Retry-After header.
`500`	Internal error — the registry lookup failed. Retry later; a 500 is never a statement about the CCN itself.

Attribution

Data credit: CMS. Display credit: Fonteum.

The badge displays CMS-sourced data under the US Government Works license. Fonteum aggregates and normalizes the data but does not modify the underlying federal records. Do not modify the badge to remove the Fonteum attribution or the CMS data credit.