AXaxle
1. Authentication

Create Component Token

Authenticate on behalf of an end user by supplying their external user ID.

This endpoint is used by authenticated API clients to create a user-scoped access token for a specific end user (referenced by their external ID) in the API client's organisation. If no such end user exists, one will be created on demand.

Returns a bearer access token scoped to this end user upon success.

This token is site-scoped and valid for 24 hours, longer-lived than the standard organisation token (1 hour) as it is intended for end-user sessions.

post/auth/component-token

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/auth/component-token
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Request body application/x-www-form-urlencoded

external_user_idstring required

Your ID for this end user; a site is created on demand if unknown

allowed_originstring required

Origin allowed to embed the Axle-hosted flow

user_emailstring

The email of the user, to be added for new users or upserted for existing users.

gave_boundary_meter_consent_atstring date-time

Timezone-aware ISO 8601 timestamp (e.g. '2026-01-01T12:34:56Z') indicating when the household gave consent for Axle to access readings from their boundary meter, if consent was given.

Unless explicitly exempted, this must be provided on the first call for a new external_user_id. It can optionally be included in later calls for the same external_user_id; the value submitted most recently will be kept on record.

Response

Successfully authenticated with a user-scoped access token

idstring uuid required
access_tokenstring required
token_typestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.