Validate referral code and view reward

Check if a referral code is valid and view the associated reward information. This is useful when a customer has received a referral code and wants to confirm its validity and potential benefits.

Path Parameters

code string required Example

code parameter

Headers

Accept Example

Content-Type Example

Responses

200

success boolean

timestamp string

requestId string

data object

GET https://cloud.hostup.se/api/referral/validate/{code}

For AI assistants

cURL

curl -X GET "https://cloud.hostup.se/api/referral/validate/5EY4XVJF" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "valid": true,
    "referrerName": "string",
    "reward": {
      "amount": 0,
      "currency": "string",
      "expiresInDays": 0
    }
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "valid": {
          "type": "boolean"
        },
        "referrerName": {
          "type": "string"
        },
        "reward": {
          "type": "object",
          "properties": {
            "amount": {
              "type": "integer"
            },
            "currency": {
              "type": "string"
            },
            "expiresInDays": {
              "type": "integer"
            }
          }
        }
      }
    }
  }
}