Hawcx Authentication SDK API Reference

Core Components

HawcxInitializer

HawcxInitializer.init(apiKey, baseUrl = null)

HawcxInitializer.getInstance()

Authentication Methods

signUp(userid)

verifyOTP(otp, isNewDevice = false)

signIn(userid)

addDevice(userid)

logout()

Response Object

All authentication methods return an AuthResponse object:

{
  success: boolean,        // Operation success status
  message: string,         // Human-readable result message
  errorCode: string|null,  // Error code if failed, null otherwise
  data: object|null        // Additional operation data
}

Error Codes

Code	Description
`NOT_INITIALIZED`	SDK not initialized
`INVALID_EMAIL`	Invalid email format
`MISSING_OTP`	No verification code provided
`OTP_VERIFICATION_FAILED`	Invalid verification code
`USER_NOT_FOUND`	User does not exist
`DEVICE_NOT_REGISTERED`	Current device not registered
`CLIENT_ERROR`	Client-side error
`EXISTING_USER`	User already exists

Code Examples

Initialize SDK

User Registration

User Sign-in

const result = await auth.signIn('[email protected]');
if (result.success) {
  const { access_token } = result.data;
  // Store token and proceed
} else if (result.errorCode === 'DEVICE_NOT_REGISTERED') {
  // Handle device registration
  const addDevice = await auth.addDevice('[email protected]');
}

Multi device flow

In order to register multiple devices under the same user account, an additional function called addDevice should be called. The flow is documented below:

Fig: Step-by-step flow for registering and authenticating multiple devices for a single user account

Multi-device Authentication Example

// 1. Attempt to sign in with email
const signInResponse = await auth.signIn(email);

// 2. Check if device needs registration
if (signInResponse.errorCode === 'DEVICE_NOT_REGISTERED') {
  
  // 3. Initiate device registration - sends verification code
  const addDeviceResponse = await auth.addDevice(email);
  
  if (addDeviceResponse.success) {
    console.log("Verification code sent to email");
    
    // 4. Get verification code from user input
    // ...user enters code in your UI...
    
    // 5. Verify the device with OTP (true parameter indicates new device)
    const verifyResponse = await auth.verifyOTP(otpCode, true);
    
    if (verifyResponse.success) {
      console.log("Device verified successfully");
      
      // 6. Try signin again now that device is registered
      const finalSignIn = await auth.signIn(email);
      
      if (finalSignIn.success) {
        // 7. Store authentication tokens
        const { access_token, refresh_token } = finalSignIn.data;
        sessionStorage.setItem('access_token', access_token);
        sessionStorage.setItem('refresh_token', refresh_token);
        
        console.log("Login successful after device registration");
      }
    } else {
      console.error("Device verification failed:", verifyResponse.message);
    }
  } else {
    console.error("Failed to initiate device registration:", addDeviceResponse.message);
  }
}

That’s it for the API reference. We’re actively improving the SDK and have some exciting improvements coming up in future releases. Please feel free to message us on Slack for support as well as feedback.

Try it out!

Example App

Check out our example app on GitHub for a complete implementation.

Community

Join our community on Slack.

Contact Support

Email us at [email protected] for direct assistance.

Get Started

API Documentation

Api reference

Hawcx Authentication SDK API Reference

Core Components

HawcxInitializer

Authentication Methods

Response Object

Error Codes

Code Examples

Multi device flow

Try it out!

Example App

Community

Contact Support

Get Started

API Documentation

​Hawcx Authentication SDK API Reference

​Core Components

​HawcxInitializer

​Authentication Methods

​Response Object

​Error Codes

​Code Examples

​Multi device flow

​Try it out!

Example App

Community

Contact Support

Hawcx Authentication SDK API Reference

Core Components

HawcxInitializer

Authentication Methods

Response Object

Error Codes

Code Examples

Multi device flow

Try it out!