Skip to main content
GET
Check whether a referral code is available
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns { code, available } for a single referral code string. available: true means no row exists in the codes directory and the code is currently free for POST /v1/affiliate/createCode. Advisory only. Two callers can both observe available: true and race on createCode; only one will end up owning the code. Use this endpoint for live form-validation feedback in the UI, but treat the createCode response as the authoritative result. Public — no X-API-Key, no signature.

Query Parameters

code
string
required

Referral code to check (uppercase A-Z, digits, _, -; 1-32 characters).

Required string length: 1 - 32
Pattern: ^[A-Z0-9_-]{1,32}$

Response

Code availability result.

code
string
required

The canonical code that was checked.

Pattern: ^[A-Z0-9_-]{1,32}$
available
boolean
required

True when the code is currently unclaimed and may be passed to POST /v1/affiliate/createCode. Advisory only — the authoritative uniqueness check happens on createCode, so a true response does not reserve the code.