Concepts
The few things RamenID is made of, and how they fit together.
Workspace
Your account is one workspace. It has a workspace address (a slug like acme) that appears in every link: ramenid.com/acme/.... You set it in Settings → Links. A workspace has one owner; there are no team members yet.
Provider connection
A connection to Stripe, Polar or Dodo Payments. RamenID uses it to list your products and to create discount codes. You can connect each provider once. See Payment providers.
Discount rule
One product and one offer: a percentage from 1 to 100, a duration, and an optional checkout link. Every rule gets its own shareable link. A rule can be turned off without deleting it. See Discount rules.
Links
Students always verify on a RamenID page with your branding. There are three kinds of link:
| Link | Looks like | Gives | Who it is for |
|---|---|---|---|
| Workspace page | ramenid.com/acme | Verification only, never a discount | Anyone; share it anywhere |
| Rule link | ramenid.com/acme/q7g1ktil (8 characters) | That rule's discount | Anyone; share it anywhere |
| API link | ramenid.com/acme/k3x9p2m7qa (10 characters) | What API links give students is set to | One student; works once, expires in 7 days |
An API link is tied to the email you created it for. The student cannot change the address on that page.
Verification
One attempt by one student: an email, a 6-digit code, and the result. Every verification appears in Verifications in the dashboard with one of these statuses:
| Status | Meaning |
|---|---|
| Code sent | We emailed a code; the student has not entered it yet |
| Verified | The student confirmed their school email (verification only) |
| Minting | We are creating the discount code in your provider |
| Discount minted | The code exists in your provider and the student has it |
| Failed | Five wrong codes in a row; the student has to start again |
| Mint failed | The student verified but the code could not be created, for example because of a plan limit or a provider error. Hover the badge for the reason |
Discount code
The code a student gets, like STU7KM2QX: STU followed by 6 letters and numbers. It is created in your provider, works once, only for the rule's product, and expires 7 days after it is created. The student's email is saved in the code's metadata in your provider.
A student who verifies again for the same rule while their code is still valid and unused gets the same code back, not a new one. If they already used it, they get a new one.
Events
When something happens, RamenID can tell your server (a webhook) or email you. There are two events: student.verified and discount.minted. See Webhooks.
How it fits together
Provider connection ──► Discount rule ──► Rule link ─────────┐
└──► API links (setting) ├──► Student verifies ──► Discount code in your provider
Workspace page (verification only) ─────────────────────────┘ └──► Webhook / email alert