# Oak & Sparrow Public Readiness Scan API

The public API runs the same Free Public AI Readiness Scan offered by the website.

## Endpoint

`POST https://oakandsparrowsystemsenterprise.io/api/scan`

Send JSON containing a valid company email and, optionally, the public website to scan:

```json
{
  "email": "person@company.example",
  "website": "https://company.example/",
  "confirmed": false
}
```

If `website` is omitted, the service derives a candidate from the company-email domain. A caller may resend a candidate with `confirmed: true` after reviewing a target-confirmation response.

## Scope and authorization

No bearer token or OAuth flow is required. This is a narrowly bounded public-evidence scanner, not a general Gatekeeper API. It retrieves public website pages only and does not authenticate, submit forms, access admin/API paths, or inspect internal agents, source code, credentials, private data, or runtime systems.

Supplying an email and target authorizes only this public scan and report-delivery workflow. It does not authorize access to Gatekeeper or other protected functionality.

## Response

The JSON response contains a compact scan status, target information, delivery status, pages reviewed, jurisdiction-group counts, and a recommended next step. Raw crawled page bodies and the full report are not returned; the full report is delivered by email when transactional delivery is configured.

This is a technical readiness review, not legal advice or a compliance certification. A clean public scan does not prove that an agent is controlled.

## Related resources

- OpenAPI: https://oakandsparrowsystemsenterprise.io/openapi.json
- API Catalog: https://oakandsparrowsystemsenterprise.io/.well-known/api-catalog
- Status: https://oakandsparrowsystemsenterprise.io/api/status
- Contact: nicksilva@oakandsparrowsystemsenterprise.io