Skip to main content
GET
/
api
/
v1
/
user
/
invite_code
Get invite code for current user
curl --request GET \
  --url https://api.hevn.finance/api/v1/user/invite_code \
  --header 'Authorization: Bearer <token>'
{
  "bonuses": {
    "kyb": {
      "amount": "<string>",
      "currency": "USD"
    },
    "volume": {
      "amount": "<string>",
      "threshold": "<string>",
      "currency": "USD"
    }
  },
  "code": "<string>",
  "totalInvited": 0
}

Authorizations

Authorization
string
header
default:Bearer <token>
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key
string | null

Response

Successful Response

Response for invite code.

bonuses
InviteBonuses · object
required

Bonus configuration for the referral program.

code
string | null
totalInvited
integer
default:0