Skip to main content
POST
/
users
/
{userId}
/
link
Connect User to NOX
curl --request POST \
  --url https://auth.nox.energy/users/{userId}/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "redirect_uri": "https://your-app.com/callback",
  "language": "en"
}
'
{
  "success": true,
  "timestamp": 1703123456,
  "data": {
    "link_token": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
    "link_url": "https://link.nox.com/connect?token=abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
    "expires_at": 1703124056,
    "supplier_id": "supplier_123",
    "supplier_user_id": "user_456",
    "brand": "daikin"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can also use 'Authorization: ApiKey YOUR_KEY' header.

Path Parameters

​
userId
string
required

The supplier's unique identifier for the user

Example:

"user_123"

Body

application/json
​
redirect_uri
string<uri>
required

URL where the user will be redirected after authentication. Must be registered with your supplier account.

Example:

"https://your-app.com/callback"

​
language
string
default:en

Language code for the UI

Example:

"en"

​
brand
enum<string>

Optional brand to pre-select for authentication. If provided, users will be taken directly to this brand's authentication instead of the brand selection screen. Only supported brands are accepted.

Available options:
daikin,
dewarmte,
viessmann,
nibe,
samsung,
alpha innotec,
lg,
mitsubishi,
vaillant,
bulex,
saunier duval,
thermia,
toshiba
Example:

"daikin"

Response

Link session created successfully

​
success
boolean
Example:

true

​
timestamp
integer

Unix timestamp

Example:

1703123456

​
data
object