Skip to main content

API Endpoint

Once the iframe posts an analysis_completed message, your backend uses the report identifier to fetch the full DiagnosticReport from the API.

Endpoint​

GET https://api.example.com/s2s/v3/anonymous-diagnostic-reports/{encryptedId}
    ?format=pdf|raw
    &locale={locale}
  • {encryptedId} (path): the id value received in the analysis_completed event. URL-encode it.
  • format (query):
    • v3 API: raw (JSON, default), fhir (FHIR-compliant JSON), or pdf (PDF binary).
    • v2 API: pdf only (works without format parameter).
  • locale (query): report language. Accepts values such as en, es, pt, and others depending on system support.

Authentication​

Send your S2S API token in the X-API-TOKEN header. The S2S token must never leave your backend.

Example cURL​

curl -X GET "https://api.example.com/s2s/v3/anonymous-diagnostic-reports/{encryptedId}\
?format=raw\
&locale=es" \
  -H "X-API-TOKEN: YOUR_S2S_TOKEN" \
  -H "accept: application/json"

Reference​

The full endpoint contract is published in the getAnonymousDiagnosticReport operation of the S2S v3 API specification.

For the schema of the report itself, see the JSON Formats section.

Next Steps​

  • Choosing an output format? See the Formats section.
  • Parsing the JSON response? See the JSON Standard page.
  • Embedding a live report in your UI? See the User Interface page.