Run instant business scan
POST /api/v1/onboarding/scan
Run a 60-90 second scan using only public data to deliver 3-5 actionable insights about the business.
Authorizations
Request Body required
Request body for POST /api/v1/onboarding/scan.
Attributes: business_name: Legal or trading name of the business. website_url: Primary website URL to scan.
object
Legal or trading name of the business
Primary website URL to scan
Responses
200
Successful Response
Response for POST /api/v1/onboarding/scan and GET …/scan/:id.
object
Payload returned when a scan completes.
Attributes: scan_id: Unique identifier for this scan. insights: List of actionable business insights. scan_duration_seconds: How long the scan took. status: Lifecycle state matching the Phase 208 vocabulary. degraded: True when the fallback extraction was used. failure_reason: Structured reason when status in {degraded, failed}.
object
True when fallback extraction was used
True when the result was served from the 24h cross-tenant domain bucket. Phase 208 UI uses this to render the rate-limit hint deterministically.
A single actionable insight from the business scan.
Attributes: title: Short headline for the insight. description: Detailed explanation of why it matters. action: Concrete next step the owner can take. impact_score: Score from 0.0 to 1.0 indicating potential impact.
object
Unique identifier for this scan
Lifecycle state matching Phase 208 vocabulary
Standard metadata included in every API response.
Attributes: request_id: Unique identifier for request tracing. timestamp: UTC timestamp of the response.
object
Unique identifier for request tracing
UTC timestamp of the response
422
Validation Error