Stream scan progress via SSE

POST

/api/v1/onboarding/scan/stream

• Production
• Local development

Run a business scan with real-time progress updates via Server-Sent Events. Each SSE event is a JSON object with type ‘progress’, ‘complete’, or ‘error’.

Authorizations

• ApiKeyAuth

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

business_name

required

Legal or trading name of the business

string

>= 1 characters <= 200 characters

website_url

required

Primary website URL to scan

string

>= 3 characters <= 500 characters

Responses

200

Successful Response

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string