🏦Tenants

API's for managing Tenants.

Production URL: https://tenants-v1-api-t3mipd377q-ey.a.run.app

Create Tenant

Requirement: Request an Auth Code from NovaX Support at [e-mail] to create a Tenant Account.

Create a Tenant.

post

Body

codestringrequired

The Auth Code provided by NovaX to create a new tenant.

namestringrequired

The name of the tenant.

contactEmailstringrequired

The contact email of the tenant - typically the admin contact email.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tenant' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "text",
    "name": "text",
    "contactEmail": "text"
  }'

200

409

500

200

{
  "apiSecret": "text",
  "apiKey": "text",
  "message": "text"
}

User successfully created.

Get Tenant Wallets

Fetches the wallets for a tenant.

get

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tenant/wallets' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

409

500

200

[
  {
    "name": "text",
    "type": "text",
    "balance": 1,
    "totalDeposited": 1,
    "totalDistributed": 1
  }
]

OK

Get Tenant Deposit Addresses

Fetches the deposit addresses for a tenant.

get

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tenant/deposit-addresses' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

409

500

200

[
  {
    "name": "text",
    "address": "text",
    "network": "text",
    "supportedTokens": [
      "text"
    ]
  }
]

OK