---
title: "Redeem Referral Code"
method: POST
path: "/api/v1/referral/redeem"
tags: ["Referral"]
---

# Redeem Referral Code

`POST /api/v1/referral/redeem`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/referral/redeem`
- Auth: HTTP bearer

Redeem a friend's referral code. One redemption per account, ever.

Errors: 400 empty/self code, 404 unknown code, 409 already redeemed,
429 when rate limited.

## Request body

- ReferralRedeemRequest
  - `code` string, required

## Response `200`

Successful Response

- ReferralRedeemResponse
  - `granted` boolean, required
  - `bonus_scans` integer, required
  - `message` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api.md) · [All operations](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gemstoneaiapp/apis/gemstoneai-api/revisions/fcb441f55161?raw)