API reference

Create a scan

Queue a scan for a URL. The scan runs asynchronously; this call returns immediately with a scan id you poll until it completes.

POST/v1/scans

Request body

Field	Type	Status	Description
url	string	required	The URL to scan. A bare domain is accepted; redirects are followed to the canonical address.

Response

Field	Type	Description
scan_id	string	Identifier to poll and to fetch the report.
status	string	One of queued, running, completed, failed. Starts as "queued".

json

{ "scan_id": "scan_8fk2…", "status": "queued" }

Examples

curl -s https://api.sifthealth.app/v1/scans \
  -H "Authorization: Bearer $SIFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.example-clinic.com"}'

Rate limits & authorization

Anonymous one-off scans are tightly rate-limited. Scan only sites you’re authorized to assess; the scan is passive and limited to publicly accessible pages.

Get a scan

Poll status with GET /v1/scans/{id}.

Get a report

Fetch the full report.

Telehealth CI

Use this in a build gate.

API overview

Auth, errors, rate limits.