Get a link
GET /api/v1/verify/{workspace}/{id} returns a link's status, and the student's discount code once it is created.
GET https://ramenid.com/api/v1/verify/{workspace}/{id}Use this to check a link if you do not use webhooks, or to double check one after a webhook arrives.
Path parameters
FieldDescription
workspacestring
RequiredYour workspace address.
idstring (UUID)
RequiredThe id returned when you created the link. Not the short code in the link's URL.
Example
curl https://ramenid.com/api/v1/verify/acme/4b8f0c2e-7d1a-4c3b-9e2f-1a6d5c8b7e90 \
-H "Authorization: Bearer $RAMENID_API_KEY"const res = await fetch(`https://ramenid.com/api/v1/verify/acme/${linkId}`, {
headers: { Authorization: `Bearer ${process.env.RAMENID_API_KEY}` },
});
const { status, coupon } = await res.json();Response
200 OK. The same fields as Create a link, plus coupon:
{
"id": "4b8f0c2e-7d1a-4c3b-9e2f-1a6d5c8b7e90",
"url": "https://ramenid.com/acme/k3x9p2m7qa",
"email": "ana@mit.edu",
"mints_discount": true,
"status": "minted",
"expires_at": "2026-10-26T18:00:00.000Z",
"created_at": "2026-10-19T18:00:00.000Z",
"completed_at": "2026-10-19T18:02:11.000Z",
"coupon": {
"code": "STUK7M2QX",
"percent_off": 40,
"expires_at": "2026-10-26T18:02:11.000Z",
"checkout_url": "https://buy.stripe.com/test_123?prefilled_promo_code=STUK7M2QX"
}
}FieldDescription
couponobject | null
null until a discount code has been created for this link.
coupon.codestring
The code, like STUK7M2QX. Works once, for the rule's product.
coupon.percent_offnumber
The percentage the code was created with. It does not change if you edit the rule later.
coupon.expires_atstring | null
When the code stops working: 7 days after it was created.
coupon.checkout_urlstring | null
Checkout with the code applied, if the rule has a checkout URL (always created for Dodo Payments).
Statuses
status | Meaning |
|---|---|
open | Not finished yet. The student may not have opened it, or may still be entering their code |
verified | Finished: the student confirmed their school email (verification-only link) |
minted | Finished: the discount code was created and shown to the student |
expired | Still open after 7 days; the page no longer accepts it |
A link stays open if the student verified but the code could not be created yet (for example your plan's discount codes ran out). They can try again from the page, and the link becomes minted when it works.
Errors
| Status | error | When |
|---|---|---|
| 400 | invalid_body | id is not a UUID |
| 401 | unauthorized | Missing, malformed, unknown or revoked key |
| 403 | wrong_workspace | The key belongs to a different workspace address |
| 404 | not_found | No link with that id in this workspace |
| 500 | server_error | Something failed on our side; safe to retry |