Api reference

Core Components

HawcxInitializer

async init(apiKey, apiEndpoint?)

HawcxInitializer.getInstance()

Smart Connect Authentication Methods

async authenticate(email)

async verify({ deviceToken, otp, userid })

async initiateQrLogin({ onPinReady, onSuccess, onError, timeout? })

Response Object

All Smart Connect authentication methods return an AuthResponse object:

{
  detail: string,         // Human-readable result message
  status: string|null,  // Operation status, e.g., "SUCCESS", "OTP_NEEDED", "INVALID_EMAIL"
  data: object|null        // Additional operation data
}

Status Codes

General & Initialization

Code	Description
`SUCCESS`	The operation was successful.
`NOT_INITIALIZED`	SDK has not been initialized. HawcxInitializer.init() must be called first.
`INITIALIZATION_FAILED`	The SDK failed to initialize, possibly due to an invalid API key or network issue.
`CLIENT_ERROR`	An unexpected client-side error occurred during an operation.

Smart Connect Email & OTP Flow

Code	Description
`INVALID_EMAIL`	The provided email address is not in a valid format.
`USER_NOT_FOUND`	The email address is not registered in the system.
`INVALID_OTP`	The One-Time Password provided by the user is incorrect.
`VERIFICATION_FAILED`	The OTP verification process failed for a reason other than an invalid OTP.
`MISSING_USERNAME`	The userid (email) was not provided to the function requiring it.

Smart Connect QR Code Flow

Code	Description
`QR_TIMEOUT`	The QR code was not scanned within the allowed time limit (default 2 minutes).
`QR_CREATE_FAILED`	Failed to create a new QR session on the server.
`POLLING_FAILED`	The periodic check for a successful scan failed, possibly due to a server-side issue.
`POLLING_ERROR`	An unexpected client-side error occurred while checking for a scan status.
`QR_INIT_FAILED`	The QR login process could not be started due to a critical client-side error.

Code Examples

Initialize Smart Connect SDK

Smart Connect Authentication

// One intelligent method handles everything
auth.authenticate('[email protected]').then(response => {
  if (response.status === "SUCCESS") {
    // Smart Connect instantly authenticated known user on trusted device
    const token = response.data;
    // ...

  } else if (response.status === "OTP_NEEDED") {
    // Smart Connect requires verification for new user/device
    const deviceToken = response.data;
    // ...

  } else {
    throw Error(`Authentication failed: ${response.message}`)
  }
});

User Verification

auth.verify({
  otp: "YOUR_OTP",
  deviceToken: deviceToken,
  userid: "[email protected]"
}).then(response => {
  if (response.status === "SUCCESS") {
    // Smart Connect authentication complete
    const accessToken = response.data;
    // ...

  } else {
    throw Error(`Verification failed: ${response.message}`);
  }
});

Smart Connect QR Code Login

auth.initiateQrLogin({
  onPinReady: ({ web_pin }) => {
    // Use web_pin to generate a QR code for the user to scan
    console.log("QR Code PIN:", web_pin);
    // e.g., new QRCode(document.getElementById("qrcode"), web_pin);
  },
  onSuccess: (authResponse) => {
    // Smart Connect authenticated user via QR
    const accessToken = authResponse.data;
    console.log("Successfully authenticated via Smart Connect QR!");
    // Redirect or update UI
  },
  onError: (error) => {
    // Handle the error, e.g., show a "timed out" message
    console.error("QR Login Failed:", error.message);
  }
});

The future of authentication is here – and it’s Smart Connect. We’re continuously enhancing this revolutionary technology to deliver even more intelligent authentication experiences. Join our community on Slack for support and to share your feedback!

Community

Join our developer community on Slack.

Contact Support

Email us at [email protected] for direct assistance.

Get Started

Dashboard

API Documentation

Core Components

HawcxInitializer

Smart Connect Authentication Methods

Response Object

Status Codes

General & Initialization

Smart Connect Email & OTP Flow

Smart Connect QR Code Flow

Code Examples

Community

Contact Support

Get Started

Dashboard

API Documentation

​Core Components

​HawcxInitializer

​Smart Connect Authentication Methods

​Response Object

​Status Codes

​General & Initialization

​Smart Connect Email & OTP Flow

​Smart Connect QR Code Flow

​Code Examples

Community

Contact Support

Core Components

HawcxInitializer

Smart Connect Authentication Methods

Response Object

Status Codes

General & Initialization

Smart Connect Email & OTP Flow

Smart Connect QR Code Flow

Code Examples