Skip to main content
POST
Connect User to NOX

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