Skip to main content
POST
/
supplier
/
link-sessions
Create supplier link session
curl --request POST \
  --url https://auth.nox.energy/v2/supplier/link-sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "<string>",
  "redirect_url": "<string>",
  "brand": "alpha innotec",
  "language": "nl"
}
'
{
  "link_url": "https://auth.nox.energy/ui?token=abc123&language=nl",
  "link_token": "<string>",
  "language": "nl",
  "redirect_url": "<string>",
  "supplier": "<string>",
  "supplier_user_id": "<string>",
  "created_at": 123,
  "expires_at": 123,
  "brand": "alpha innotec",
  "completed_at": 123
}

Authorizations

​
x-api-key
string
header
required

API key assigned to the supplier.

Body

application/json
​
user_id
string
required

The supplier's internal user ID for the end-user.

​
redirect_url
string<uri>
required

Callback URL where the user is redirected after completing the flow. Must be in the supplier's allowed redirect URLs.

​
brand
enum<string> | null

Optionally pre-select a manufacturer brand.

Available options:
alpha innotec,
bulex,
daikin,
dewarmte,
lg,
mitsubishi,
nibe,
saunier duval,
toshiba,
thermia,
vaillant,
viessmann
​
language
enum<string>
default:nl

Language for the Authenticator UI.

Available options:
nl,
en,
fr,
es

Response

Link session created successfully.

​
link_url
string<uri>
required

Full URL to redirect the end-user to the NOX Authenticator UI.

Example:

"https://auth.nox.energy/ui?token=abc123&language=nl"

​
link_token
string
required

Unique token identifying this link session.

​
language
enum<string>
default:nl
required

Language for the Authenticator UI.

Available options:
nl,
en,
fr,
es
​
redirect_url
string<uri>
required

The redirect URL that was provided.

​
supplier
string
required

Name of the supplier (resolved from API key).

​
supplier_user_id
string
required

The supplier's user ID.

​
created_at
integer
required

Unix timestamp when the session was created.

​
expires_at
integer
required

Unix timestamp when the session expires (10 minutes after creation).

​
brand
enum<string> | null

Pre-selected brand, if provided.

Available options:
alpha innotec,
bulex,
daikin,
dewarmte,
lg,
mitsubishi,
nibe,
saunier duval,
toshiba,
thermia,
vaillant,
viessmann
​
completed_at
integer | null

Unix timestamp when the session was completed. Always null on creation.