orangecheck · Glossary
The same word for the same thing, everywhere: ochk.app, me.ochk.io, ochk.io, these docs and the SDK. Where the API uses a different name, it is in the last column. API names do not change.
For everyone
| Word | What it means | In the API |
|---|---|---|
| account | Your orangecheck account: one account for every app that uses orangecheck. | did_oc, sub |
| account id | The account's id. The same in every app, so apps that compare notes can match you. | did_oc (did:oc:…) |
| ways to sign in | Email, Google, GitHub or a Bitcoin wallet. A second way in is also your way back. | linked identities |
| back your account · backed by bitcoin · coin | You show that you hold one coin, and it backs your account. The coin stays in your wallet. An app can let in only backed accounts. | bond: oc_bond, requireBond, bond_required (bonds) |
| the bar | What an app asks of a backed account: at least N sats, held at least D days. | floor: min_sats, min_days |
| app | A service you sign in to with orangecheck. | integrator, site |
| event | One thing you did in an app that pays its users. | billable event, subtype |
| receipt | The signed record of one event. Anyone can check it offline against Bitcoin. | envelope |
| Earned · Waiting · Ready to cash out · Paid out | Where your sats are: earned, waiting until a date the app set, ready for you to take, or sent. | accrued, vesting / maturing, available, settled |
| Cash out · payout | Taking ready sats out to where you choose. | distribution, settlement |
| move to your own keys | Holding your sats yourself instead of orangecheck holding them. Not open yet. | graduation, self-custody |
| statements | What apps say about an account: good, caution, or refused. | trust attestations |
| what you share | What you let an app see beyond your account id, item by item. You can take any of it back. | scopes |
| In testing | Working, with real limits, before it is fully open. Paying users is in testing. | testnet, beta |
For developers
| Word | What it means | In the API |
|---|---|---|
| project | Your app's record on orangecheck: its key, its domain, who can sign in, and whether it pays. | project_key, IntegratorPriceConfig |
| who can sign in | Everyone, or only accounts backed by bitcoin above your bar. Details. | require_bond, projectKey in withOcAuth |
| Pay your users: Off · Always · Promos | Whether your events earn your users sats right now. Details. | pay periods, pay_periods, not_paying |
| Your user earns N sats | What one event pays your user. You pay N ÷ 0.8: the 20% fee is included. | site_pays, user_share_pct |
| One-time · Per action · Per session | The three event groups: things done once (signing up), each time (a payment), and every session. | class A · B · C |
| balance · Top up | The sats your project holds to pay its users. "About N days left" is how long it lasts at your current rate. | escrow, runway |
| Release schedule | When your users' shares are theirs: right away (the default), or in batches, weekly, monthly or when you say. Details. | drops, drop windows, drop.closed |
A bond backs an account: that is the one place the protocol word meets the product word. In these docs, "Bitcoin-backed" describes only an account that is backed.