😄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

application/json

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

200

User successfully created.

application/json

userIdstringOptional

NovaX user id of the user. This is the unique identifier of the user in the NovaX system.

thirdPartyUserIdstringOptional

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

409

User with the same third party user id already exists.

500

Internal error.

post

/user

HTTPcURLJavaScriptPython

POST /user HTTP/1.1
Host: users-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "thirdPartyUserId": "text",
  "firstName": "text",
  "lastName": "text",
  "languageCode": "text",
  "email": "[email protected]",
  "country": "text",
  "dateOfBirth": "2026-02-23",
  "phoneNumber": "text"
}

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

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

200

The User Information.

application/json

userIdstringOptional

NovaX user id of the user. This is the unique identifier of the user in the NovaX system.

thirdPartyUserIdstringRequired

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

firstNamestringRequired

First name of the user.

lastNamestringRequired

Last name of the user.

languageCodestringRequired

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

emailstring · emailRequired

Email of the user.

countrystringRequired

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

dateOfBirthstring · dateRequired

Date of birth of the user.

phoneNumberstringOptional

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

get

/user

HTTPcURLJavaScriptPython

GET /user HTTP/1.1
Host: users-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Accept: */*

200

The User Information.

{
  "userId": "text",
  "thirdPartyUserId": "text",
  "firstName": "text",
  "lastName": "text",
  "languageCode": "text",
  "email": "[email protected]",
  "country": "text",
  "dateOfBirth": "2026-02-23",
  "phoneNumber": "text"
}

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

200

Returns a mysterious string.

application/json

totalBalancenumberOptional

The users total balance.

mainBalancenumberOptional

The users main balance.

pendingBalancenumberOptional

The users pending balance.

get

/user/balances

HTTPcURLJavaScriptPython

GET /user/balances?userId=text HTTP/1.1
Host: users-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Accept: */*

200

Returns a mysterious string.

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

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

200

OK

application/json

addressstringOptional

The deposit address for the tenant.

networkstringOptional

The network for the deposit address.

supportedTokensstring[]Optional

The supported tokens for the deposit address.

409

Permission denied.

500

Internal error.

get

/user/deposit-addresses

HTTPcURLJavaScriptPython

GET /user/deposit-addresses?userId=text HTTP/1.1
Host: users-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Accept: */*

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

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

application/json

emailstringOptional

NovaX user email.

userIdstringOptional

NovaX user id.

thirdPartySessionIdstringOptional

Your system session id to identify this request.

Responses

200

User successfully created.

application/json

urlstringOptional

The URL to the card web portal.

sessionIdstringOptional

The session id to identify this request.

thirdPartySessionIdstringOptional

Your system session id to identify this request.

500

Internal error.

post

/user/card-web-portal

HTTPcURLJavaScriptPython

POST /user/card-web-portal HTTP/1.1
Host: users-v1-api-t3mipd377q-ey.a.run.app
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "email": "text",
  "userId": "text",
  "thirdPartySessionId": "text"
}

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