Authentication

Login and token reference

Use these endpoints to authenticate against the public API and refresh access tokens when needed.

Login endpoint

MethodGET
Route/api/Authenication/login?username={username}&password={password}
AuthAnonymous access allowed
Inputusername and password as query parameters
ResponseLogged-in user object including id, userType, token, and expiry
{
  "firstName": "string",
  "lastName": "string",
  "id": "string",
  "email": "string",
  "username": "string",
  "userType": "Partner",
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expiresUTC": "2026-03-30T00:00:00Z",
  "requiresTwoFactor": false
}

Refresh token endpoint

MethodPOST
Route/api/Authenication/refresh-token
AuthBearer token required
InputNo body
ResponseString token value
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Portal behavior

The webhook admin only allows partner accounts. If userType is not Partner, login is rejected.

The portal uses the returned id as the partner ID automatically.

The current API still sends credentials in the query string, which works but is not ideal for public integrations.