Get invite code for current user

Get the current user’s invite code, creating one if needed.

GET /api/v1/user/invite_code

Get invite code for current user

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/user/invite_code \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/user/invite_code"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/user/invite_code', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "bonuses": {
    "kyb": {
      "amount": "<string>",
      "currency": "USD"
    },
    "volume": {
      "amount": "<string>",
      "threshold": "<string>",
      "currency": "USD"
    }
  },
  "code": "<string>",
  "totalInvited": 0
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

200

application/json

Successful Response

Response for invite code.

bonuses · InviteBonuses · object · required

Bonus configuration for the referral program.

Show child attributes

code · string | null

totalInvited · integer · default: 0