Validate Referral

POST

https://api.gatewayz.ai/referral/validate

Validate if a referral code can be used by the authenticated user.

Checks:

Code exists

User hasn't already used a referral code

User hasn't made their first purchase yet

Code hasn't reached its usage limit (10 uses)

User isn't trying to use their own code

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Successful Response

Body

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.gatewayz.ai/referral/validate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "referral_code": "string"
}'

Response Example

200 - Example 1

{
    "valid": true,
    "message": "string",
    "referrer_username": "string",
    "referrer_email": "string"
}

Modified at 2025-11-07 03:16:43

Get My Referral Stats

Generate My Referral Code