RamenIDDocs

Branding and links

Your logo and details on student pages, your workspace address, what API links give, and where students go afterwards.

Branding

Settings → Branding controls the header of every page students verify on. A live preview shows the result as you type.

Logo
PNG, JPEG or WebP
Up to 512 KB. Square works best. SVG is not accepted.
Company name
Required
Up to 80 characters.
Short description
Optional
Up to 280 characters, shown under your name.
Website
Optional
Must start with https://.

Settings → Links lists every link you can share, with copy and open buttons: your workspace page, one link per discount rule, and an explanation of API links.

Workspace address

The part of every link after ramenid.com/. Use 3 to 32 lowercase letters, numbers or hyphens, not starting or ending with a hyphen, and no double hyphens. Some names, like docs or dashboard, are reserved.

Changing it breaks existing links

Every link moves to the new address at once. Links you already shared stop working, and API calls with the old address in the URL get 403 wrong_workspace. Update your integration at the same time.

Choose one of your rules, or Verification only, no discount. This applies to every link you create with the API, and is saved onto each link when it is created: changing the setting later does not change links you already created.

If the chosen rule is turned off, creating a link fails with 409 discount_off. If it is deleted, API links become verification only.

After verifying, send students to

An optional redirect URL (https, up to 500 characters). It is used when:

  • Verification only: the student is sent there automatically about two seconds after verifying, with a Continue button in case.
  • Discount without a checkout URL: the student sees their code and a Continue button to this URL.

If a rule has a checkout URL, students go to checkout instead.

We add one parameter so your page knows what happened:

ParameterValue
ramenid_statusverified or minted

No email, code or link id is added. Use webhooks or Get a link to learn who verified.