every doc surface, indexed.
the dashboard renders your project state. the conceptual model + drop-in code lives across the public docs surfaces. links below; everything else is in the SDK README.
- sdk reference · @orangecheck/me-client v0.4.0 ↗
every export · provider, hooks, oc.session, oc.payment, oc.config, oc.webhook, oc.delegation. type signatures + code samples.
- integrate · drop-in samples ↗
OAuth-peer pattern (alongside google/apple/magic-link), standalone html + react samples, configurator.
- sandbox · model your costs ↗
pick a preset, pick a traffic tier, see the four-way split for one month vs the auth0 + stripe + twilio + kyc legacy stack.
- pricing · the platform fee ↗
20% fixed, 5 sat floor, every event invariant published and CI-tested.
- verify · the public envelope verifier ↗
live trace of canonicalization → sha-256 → JWKS fetch → ed25519 verify, runs entirely in the browser.
- security · the offline recipe ↗
verify any envelope without OC servers — bash + node + an ots calendar.
- charter · what we will and won’t do ↗
pinned identical to console.ochk.io. no token, no custody (federation-default with self-custody graduation), no protocol fork.
// 1. drop the button
import { OcSignInButton } from '@orangecheck/me-client';
<OcSignInButton scope={['identity']} />
// 2. read the session anywhere
import { useOcSession } from '@orangecheck/me-client';
const { account, status } = useOcSession();
// 3. authorize a payment
import { oc } from '@orangecheck/me-client';
const env = await oc.payment.authorize({ amount_sats: 21_000, memo: 'one widget' });
// env.id is the content-addressed envelope you can show on /verify/[id]
// 4. verify the webhook OC sent you
// see /developer/webhooks for the full reception sampleStuck on a verification edge case, an unusual traffic shape, or a regulator's question we haven't answered publicly? Email /contact with what you're trying to do — paired comparisons against your actual invoices come back inside a business day.