CleanedWeb Docs

Enterprise integration contract

Semantics, security,
and operational truth.

The implementation details needed to evaluate, integrate, and operate CleanedWeb without guessing. Every static policy defers to the live capability manifest, authenticated workspace state, and persisted usage receipts.

Review contracts Open workflows
01Runtime before documentation
02Canonical identity with provenance
03Bounded requests and receipts
04Stop instead of guessing
RegistryMachine-readable

One authority for each decision.

Agents and applications should not scrape prose to discover a field, limit, workflow, or event. Static contracts below load from the public site without a portal session; runtime operations remain on the app API.

Runtime readiness/v1/capabilitiesJSON ↗ HTTP operations/openapi.jsonOAS 3.1 ↗ Property structureproperty-profile-v2Schema ↗ Field semanticsproperty-profile-field-catalog-v2JSON ↗ Deterministic workflowsboundedPropertySearchArazzo ↗ Webhook deliveryproperty-event-v1AsyncAPI ↗ Contract historychangelog-v1JSON ↗
Data semanticsIdentity + provenance

Know what a property value actually means.

Use property_entity_id for canonical upserts and retain sources as advertisement provenance. A listing ID, address, coordinate, title, or agent name is not a substitute canonical key.

Omitted

No delivery-safe value exists. Never convert omission to zero, false, or an inferred fact.

Unknown

An explicit classification only where the schema defines it. It is not permission to guess.

Observed

A retained CleanedWeb observation. It is not automatically a transaction or legal-event time.

Source

An advertisement-level value. Presence does not guarantee reachability, ownership, consent, or future availability.

Normalized unitsm² · WGS84 · ISO 4217 · RFC 3339

Market-specific definitions can still vary. Normalization does not erase the source-market boundary.

Read the complete data and provenance policy →
SecurityLeast privilege

Credentials stay with the trusted client.

Browser sessions, server API keys, and MCP clients share the property contract but not the credential boundary. A key belongs to one workspace, carries properties:read, is shown once, stored as a hash, and can be revoked.

Browser__Host-cw_session

Secure signed-in workspace session. Never expose it to model context.

RESTcw_… Bearer key

Trusted server only. Use separate keys by application and environment.

MCPcw_… Bearer key

Client adapter owns it. Never pass tokens through tools or prompts.

Webhookwhsec_…

Verify raw bytes, timestamp, and all supported v1 signatures before parsing.

Current boundary

OAuth discovery, SSO, SCIM, certifications, data residency, and numeric SLA claims are not published by this contract. They must not be inferred from API-key access or a successful health probe.

Read authentication, rotation, redaction, and reporting details →
LifecycleVersion-safe

Independent versions, explicit breaking changes.

Capabilities, HTTP operations, property records, events, errors, fields, and MCP protocol negotiation have independent versions. Record them at workflow start and reject unsupported major versions.

  1. 1
    Announce

    Publish affected operations and schemas in the changelog.

  2. 2
    Explain

    Provide old/new examples and a migration guide.

  3. 3
    Date

    Publish a support end date only when it is contractually established.

  4. 4
    Enforce

    Use runtime or response signals before withdrawing the old contract.

Compatibility policyVersioning guide → Machine-readable historyChangelog JSON ↗
OperationsFail safely

Bound the request and preserve its evidence.

Limits and Unit prices come from capabilities. Entitlement comes from the authenticated market list. Billing truth comes from the committed receipt.

429

Wait for Retry-After and preserve the same idempotency key.

503

Retry with bounded exponential backoff and jitter. Never return empty data.

409

Do not raise max_units or replace an idempotency key without a changed plan.

422

Correct validation or obtain the user's location decision before retrying.

Escalation evidenceworkspace · UTC time · request ID · stable error

Redact credentials and unnecessary property or contact payloads.

Read limits, retries, freshness, receipts, and support evidence →
WorkflowsHuman + agent

Runnable paths with explicit stop conditions.

The Arazzo contract provides bounded search and property-history workflows. Human-readable recipes add location resolution, acceptance, recovery, and webhook processing decisions.

1Discovercapabilities
→
2Entitlemarkets
→
3Resolvelocation
→
4BoundUnits + limit
→
5Acceptvalidate + persist
Executable operationsArazzo JSON ↗ Decision proceduresWorkflow recipes →
Enterprise rolloutEnvironment + ownership

Move from contract review to operated delivery.

Keep credentials, customer decisions, CleanedWeb runtime contracts, and downstream persistence in explicit trust zones. Promotion requires evidence from the same workflow that will operate in production.

Environment architecture
Customer systemsProduct · CRM · analyticsDefines the permitted business workflow
Trusted integrationBackend · MCP adapterOwns credentials, bounds and acceptance
CleanedWebAPI · contracts · receiptsEnforces scope and returns evidence
Customer deliveryDatabase · webhook receiverPersists accepted state and event identity
AreaCustomerCleanedWebShared acceptance
Security

Store and rotate client credentials

Enforce workspace scope and entitlement

Verify the tested trust boundary

Data

Choose permitted uses and interpretation

Preserve canonical identity and provenance

Validate schema, counts and freshness

Operations

Persist receipts and monitor consumers

Publish runtime capability and stable errors

Exercise recovery and escalation

Legal

Own licensing and compliance program

State published contractual boundaries

Record approved scope before launch

  1. 01Contract reviewScope, markets, security and legal boundaries
  2. 02IntegrationCapabilities, schemas and bounded workflows
  3. 03AcceptanceCounts, persistence, receipts and recovery
  4. 04ActivationApproved environment and credentials
  5. 05OperateFreshness, errors, versions and evidence
Operational evidencecapability version · request ID · terminal status · returned/persisted counts · schema · Units · freshness

A green request alone is not acceptance. Retain the evidence needed to reproduce the decision.

AI agentsData contract ErrorsMCP OperationsReference clients SecurityVersioning WebhooksWorkflows
Primary publications OpenAPI ↗ Arazzo ↗ AsyncAPI ↗ OWASP API Security ↗ MCP authorization ↗
Trust boundaryNo invented guarantees

Enterprise-grade means saying what is not established.

CleanedWeb publishes implementation truth that can be validated. It does not convert roadmap items, configuration, successful requests, or marketing coverage into unsupported availability, compliance, freshness, or legal claims.

EventsAsyncAPI

Headers, messages, retries, duplicate behavior, and test delivery.

 ClientsReference implementations

Dependency-free Python and TypeScript-compatible examples.

 AgentsMCP behavior

Output schemas, resources, metering, and credential isolation.

 RecoveryError contract

Stable codes, retry boundaries, and safe failure behavior.
Enterprise reviewBring the exact security, legal, and operational requirements.
Start review