API Reference

Complete reference for the HelioRim Client SDK and REST API.

React Hooks Reference

Complete documentation for all 10 React hooks provided by @heliorim/sdk-react:

Framework Guides

Step-by-step integration guides for each supported framework:

Client SDK Overview

The HelioRim Client SDK provides a simple interface for passkey authentication:

npm install @heliorim/sdk

Core Methods

const result = await auth.register({
  email: 'user@example.com',
  displayName: 'John Doe',
  userVerification: 'required'
});

const result = await auth.login({
  email: 'user@example.com',
  userVerification: 'required'
});

REST API Overview

Base URL: https://api.heliorim.dev

Authentication

All API requests require authentication via API key in the header:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Core Endpoints

{
  "email": "user@example.com",
  "displayName": "John Doe",
  "userVerification": "required"
}

{
  "email": "user@example.com",
  "userVerification": "required"
}

Authorization: Bearer SESSION_TOKEN

Error Handling

All API errors follow a consistent format:

{
  "error": {
    "code": "CREDENTIAL_NOT_FOUND",
    "message": "No passkey found for this user",
    "details": {
      "email": "user@example.com"
    }
  }
}

Common Error Codes