Sign in
latestOpenAPI 3.1.02026-08-1051108155.9 KB

6e6f8dad92bf

Referral

Activates the sender to acquire a referral code

post/v1/referral/activate

Request body

signaturestring hex required

Hex-encoded EIP-712 signature authorizing this request

Example request

{
  "data": {
    "sender": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "signedAt": 1712019600,
    "subaccount": "0x7072696d61727900000000000000000000000000000000000000000000000000"
  }
}

Response

codestring

The referee's referral code to be shared and claimed by others (undefined if not activated)

codeUsageRemaininginteger required

Number of remaining times the referral code can be claimed

createdAtinteger required

Timestamp of when this referral was activated (ms since Unix Epoch)

idstring uuid required

Id representing the referral

refereestring hex required

Address of the referee (non-checksummed)

refereeTotalPointsstring decimal required

Total points (excl. referral points) earned by the referee since referee claimed the code (precision: 9)

referrerstring hex

Address of the referrer (non-checksummed; undefined if not set)

Example response

{
  "code": "XYZ123456789",
  "codeUsageRemaining": 5,
  "createdAt": 1712019600000,
  "id": "9036443a-441a-4a66-87f2-bd5c44cdca7a",
  "referee": "0x4c9EDD5852cd905f086C759E8383e09bff1E68B3",
  "refereeTotalPoints": "1234567.890000000",
  "referrer": "0x41e038d9c9aF27369EcBCe72A69a96695A1fD0D3"
}