Partner Integration Overview

Phosra operates a hosted OCSS census — an OCSS Trust-Framework-conformant relay that routes signed child-safety rules between parental-controls providers and the apps where children consume content. There are two roles. Every integration is one or both.

Role	Who	SDK	What you do
Provider	parental-controls vendor	`@phosra/link`	Link families, ingest parent consent, write rules
Platform	content or service app	`@phosra/gatekeeper`	Receive signed rule profiles, enforce locally, confirm

The two SDKs speak the same OCSS Trust Framework protocol under the hood. All cryptographic signing happens in your process — your private key never leaves your machine. The hosted census persists, distributes, and confirms; your SDK verifies.

Before you write any code

Run the CLI to prove the setup end-to-end against the shared sandbox in under two minutes. No account required.

# 1. Install the CLI
npm install -g @phosra/cli

# 2. Scaffold a config file wired to the production sandbox (the canonical partner host)
phosra init --role provider  # or --role platform

# 3. Verify: census reachable, trust list verified, spec version negotiated, signed round-trip
phosra doctor

phosra doctor runs five checks and exits 0 on green:

Census reachable (GET /health — mounted at the ROOT, not under /api/v1)
Trust list verified (Ed25519 root signature against the baked-in root key)
Capabilities doc verified (123-rule self-describing document, WARN if absent)
Spec-version negotiation (client ↔ server OCSS version range agreement)
Signed sandbox round-trip (§8.3.2 consent attestation + §8.3.1 rule write, both 201)

The sandbox wired by phosra init is the production sandbox census (phosra-api-sandbox-production.up.railway.app) — the one canonical partner host, with no new backend, no database, no provisioning. (Phosra runs a separate -staging census for its own pre-release testing; it is not a partner surface — see Environments → the two sandbox hosts.)

SDK availability

All five SDKs (@phosra/link, @phosra/gatekeeper, @phosra/cli, @phosra/sdk, and @openchildsafety/ocss) are published on npm. See the status page for full version info.

Pricing — the §12.3 line

The OCSS standard and both SDKs are MIT-licensed. You can run your own census at zero cost. You pay Phosra only when Phosra operates the census for you.

SDK operations (signing, verifying, the local isAllowed decision) — free, always
Safety-path operations (enforcement profile reads, enforcement confirmations, proposals) — free, never metered
Hosted census operations (consent ingest, grant mint, endpoint binding, rule writes, profile distribution) — metered per distinct linked family

The §12.3 line is the pricing boundary: local crypto and enforcement are free; hosted persistence and distribution are paid.

You pay for the connection, never for keeping a kid safe.

For the full billing model, see Billing.

What is live today

Surface	Status
Sandbox census (`phosra-api-sandbox-production.up.railway.app`)	Live — zero account required (sandbox only — not the production network)
`/.well-known/ocss/trust-list` (signed, verified to root)	Live
`/.well-known/ocss/capabilities` (123 rules, signed)	Live
`phosra init` / `phosra doctor` / `phosra caps`	Live — on npm
`@phosra/link` (Provider SDK)	Live — on npm
`@phosra/gatekeeper` (Platform SDK)	Live — on npm
Self-serve Trust List registration (sandbox)	Live — `phosra register` or `POST /api/v1/advisors/self-register`
Production Trust List accreditation	Vetted gate — apply here
Production OCSS census (interim bootstrap — provider connect, enforcement-endpoints, rule writes)	Live for accredited parties — coordinates
Control-plane API (`prodapi.phosra.com/api/v1`)	Live — requires `phosra_` API key (control plane, not an OCSS census)

CLI quickstart

phosra init → phosra doctor → green signed round-trip in under two minutes

Provider quickstart

@phosra/link — connect a family, ingest consent, write rules

Platform quickstart

@phosra/gatekeeper — receive profiles, decide locally, confirm enforcement

Billing model

Per-family FamilyMeter — what is metered, what is always free

Get Started

Concepts

Guides

Cookbook