😄Users

API's to manage Users.

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

Create User

Create a new user.

post

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

thirdPartyUserIdstringoptional

Third party user id of the user. This is the unique identifier of the user in the third party system.

firstNamestringoptional

First name of the user.

lastNamestringoptional

Last name of the user.

languageCodestringoptional

Language code of the user. e.g. en, fr, es etc.

emailstring · emailoptional

Email of the user.

countrystringoptional

Country of the user. e.g. EU, NG, US etc.

dateOfBirthstring · dateoptional

Date of birth of the user.

phoneNumberstringoptional

Phone number of the user. e.g. [phone]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/user' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "thirdPartyUserId": "text",
    "firstName": "text",
    "lastName": "text",
    "languageCode": "text",
    "email": "[e-mail]",
    "country": "text",
    "dateOfBirth": "2025-04-03",
    "phoneNumber": "text"
  }'

200

409

500

200

{
  "userId": "text",
  "thirdPartyUserId": "text"
}

User successfully created.

Get User

Fetch the user by userId, thirdPartyUserId or email.

get

Query parameters

userIdstringoptional

The NovaX user id.

thirdPartyUserIdstringoptional

The Tenant user id.

emailstringoptional

The Tenant user email address.

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 '/user' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

200

{
  "userId": "text",
  "thirdPartyUserId": "text",
  "firstName": "text",
  "lastName": "text",
  "languageCode": "text",
  "email": "[e-mail]",
  "country": "text",
  "dateOfBirth": "2025-04-03",
  "phoneNumber": "text"
}

The User Information.

Get User Balances

Fetch the balances of the user by id.

get

Query parameters

userIdstringrequired

The user id.

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 '/user/balances?userId=text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

200

{
  "totalBalance": 1,
  "mainBalance": 1,
  "pendingBalance": 1
}

Returns a mysterious string.

Get User Crypto Deposit Addresses

Fetches the deposit addresses for a user.

get

Query parameters

userIdstringrequired

The user id.

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 '/user/deposit-addresses?userId=text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

409

500

200

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

OK

Create te User Card Web Portal

Create a Card Web Portal Session for a User.

post

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

emailstringoptional

NovaX user email.

userIdstringoptional

NovaX user id.

thirdPartySessionIdstringoptional

Your system session id to identify this request.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/user/card-web-portal' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "text",
    "userId": "text",
    "thirdPartySessionId": "text"
  }'

200

500

200

{
  "url": "text",
  "sessionId": "text",
  "thirdPartySessionId": "text"
}

User successfully created.