oc · docs
overview

orangecheck

One account, with Bitcoin behind it. People sign in the way they already do (email, Google, GitHub or a Bitcoin wallet) and use the same account in every app that uses orangecheck. The product lives at ochk.app. The API, the sign-in popup and the SDK talk to me.ochk.io, the API host.

Sign inBack itGet paidOwn it
Live. Free for every app.Live. One coin backs an account and stays in its owner's wallet.Optional for apps, in testing. Each paid event has a receipt.Not open yet. Moving to your own keys is the path.

For apps, sign-in is free and stands on its own. An app can let in every account, or only accounts backed by bitcoin, so bots and farms cost something real without anyone showing an ID. Paying your users is optional: always, in promos, or never.

Custody, stated plainly. Backing leaves the coin in its owner's wallet. Earned sats are different: today orangecheck holds them while payouts are in testing. A federation is next, then keys the person holds. The live state is at ochk.app/custody and machine-readable at https://me.ochk.io/api/federations.

Start here

For…Start here
PeopleSign in at ochk.app with email, Google, GitHub or a Bitcoin wallet.
DevelopersThe Quickstart: sign-in first, then paying your users if you want it. Create your project at ochk.app.
SDK reference@orangecheck/me-client: signInWithOc, withOcAuth, oc.event, oc.webhook, oc.config, with @orangecheck/auth-client for React.
The wordsThe glossary: account, backing, receipt, balance, release schedule, and what each is called in the API.
Under the hoodThe same OC Attest, Lock, Stamp and Agent primitives documented elsewhere here: Attest, Lock, Stamp, Agent.

Pages in this section

Where the source of truth lives

  • Protocol contracts: oc-attest-protocol, oc-lock-protocol, oc-stamp-protocol, oc-agent-protocol. The v1.2-draft-1 federation custody extension is at oc-attest-protocol/FEDERATION-CUSTODY.md.
  • App: oc-app-web (ochk.app). API: oc-me-web (me.ochk.io), which also serves the sign-in popup.
  • SDK: oc-packages/me-client, published to npm as @orangecheck/me-client.
  • Docs: this section, in oc-docs.

The contract is the protocol; orangecheck is one implementation. Anyone can run their own against the same receipts. No token, no airdrop: sats are the unit of account.