Referral Code

Query the referral code of a provided subaccount.

Note: only valid Vertex subaccounts have referral codes.

Rate limits

• 1200 requests/min or 200 requests/10secs per IP address. (weight = 2)

See more details in API Rate limits

Request

Referral code

POST [ARCHIVE_ENDPOINT]

Body

{
  "referral_code": {
    "subaccount": "0x7a5ec2748e9065794491a8d29dcf3f9edb8d7c4364656661756c740000000000"
  }
}

Request Parameters

Parameter	Type	Required	Description
subaccount	string	Yes	A bytes32 sent as a hex string; includes the address and the subaccount identifier.

Response

Note:

• null is returned for the referral_code if the subaccount doesn't exist i.e: has not deposited into Vertex.

• All subaccounts of the same wallet share the same referral code.

{
  "referral_code": "SmRA7MGhgE"
}

Response Fields

Field name	Description
referral_code	Unique referral code associated to the provided subaccount.